Synadia Communications System API
The system API from Synadia Communications — 35 operation(s) for system.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/synadia-communications-system-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: API for Synadia Control Plane / Synadia Cloud
title: Synadia Control Plane / Synadia Cloud System API
version: beta
servers:
- description: Path to Synadia Control Plane Server Api
url: '{baseUrl}/api'
variables:
baseUrl:
default: ''
security:
- bearerAuth: []
sessionAuth: []
tags:
- name: System
paths:
/core/beta/systems/{systemId}:
delete:
description: Deletes System
operationId: deleteSystem
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Delete System
tags:
- System
x-doc-tags:
- Systems
get:
description: Returns a System by ID
operationId: getSystem
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SystemViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get System
tags:
- System
x-doc-tags:
- Systems
patch:
description: Updates a System
operationId: updateSystem
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- description: To test the backend connection without updating the system, pass test_connection=true in query parameter.
explode: true
in: query
name: test_connection
required: false
schema:
type: boolean
style: form
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SystemUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SystemViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Update System
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/accounts:
get:
operationId: listAccounts
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Accounts
tags:
- System
x-doc-tags:
- Accounts
post:
operationId: createAccount
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create Account
tags:
- System
x-doc-tags:
- Accounts
/core/beta/systems/{systemId}/accounts-overview-metrics:
get:
operationId: listAccountsOverviewMetrics
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsOverviewListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Accounts overview metrics
tags:
- System
x-doc-tags:
- Accounts
/core/beta/systems/{systemId}/agent-tokens:
get:
operationId: listAgentTokens
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AgentTokenListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Agent Tokens
tags:
- System
x-doc-tags:
- Accounts
post:
description: Rotate token to connect a dataplane agent
operationId: rotateAgentToken
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AgentTokenRotateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AgentTokenRotateResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Rotate Agent Token
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/agent-tokens/current:
get:
description: Get the Current Agent Token
operationId: getCurrentAgentToken
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AgentTokenCurrentResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Current Agent Token
tags:
- System
x-doc-tags:
- App Users
/core/beta/systems/{systemId}/alert-rules:
get:
operationId: listSystemAlertRules
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List System Alert Rules
tags:
- System
x-doc-tags:
- Alerts
post:
operationId: createSystemAlertRule
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleSystemCreateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create System Alert Rule
tags:
- System
x-doc-tags:
- Alerts
/core/beta/systems/{systemId}/alert-rules/{alertRuleId}:
delete:
description: Delete System Alert rule
operationId: deleteSystemAlertRule
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: alertRuleId
required: true
schema:
type: string
style: simple
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Delete System Alert Rule
tags:
- System
x-doc-tags:
- Alerts
get:
operationId: getSystemAlertRule
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: alertRuleId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get System Alert Rule
tags:
- System
x-doc-tags:
- Alerts
patch:
operationId: updateSystemAlertRule
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: alertRuleId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Update System Alert Rules
tags:
- System
x-doc-tags:
- Alerts
/core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run:
get:
description: Run System Alert Rule and return an alert object if the rule condition is met
operationId: runSystemAlertRule
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: alertRuleId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AlertViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Run System Alert Rule
tags:
- System
x-doc-tags:
- Alerts
/core/beta/systems/{systemId}/app-users:
get:
description: Returns a list of Team App Users associated with the System
operationId: listSystemTeamAppUsers
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AppUserAssignListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List System Team App Users
tags:
- System
x-doc-tags:
- App Users
/core/beta/systems/{systemId}/app-users/{teamAppUserId}:
delete:
description: Unassign a Team App User from a System
operationId: unAssignSystemTeamAppUser
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: teamAppUserId
required: true
schema:
type: string
style: simple
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Unassign Team App User from System
tags:
- System
x-doc-tags:
- App Users
post:
description: Assign a Team App User to a System. This operation is idempotent; if an App User is already assigned to the System the assignment will be updated with the new role
operationId: assignSystemTeamAppUser
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: teamAppUserId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AppUserAssignRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AppUserAssignResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Assign Team App User to System
tags:
- System
x-doc-tags:
- App Users
/core/beta/systems/{systemId}/audit/jobs:
get:
description: Returns a list of recent audit jobs for the system, ordered by creation time (most recent first)
operationId: listSystemAuditJobs
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditJobListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Audit Jobs
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/audit/jobs/{jobId}:
get:
description: Returns the current status of an asynchronous audit job
operationId: getSystemAuditJobStatus
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: jobId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditJobResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Audit Job Status
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/audit/jobs/{jobId}/result:
get:
description: Returns the analyzed audit results for a completed job
operationId: getSystemAuditJobResult
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: jobId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditHealthResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Audit Job Result
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/audit/run:
post:
description: Starts an asynchronous system audit check and returns job tracking information
operationId: runSystemAuditCheck
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuditJobRequest'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditJobResponse'
description: Accepted
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Run System Audit Check
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/auth-callout:
get:
description: List Auth Callout Configs for the System
operationId: listAuthCalloutConfigs
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthCalloutConfigListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Auth Callout Configs
tags:
- System
x-doc-tags:
- Systems
post:
description: Saves an auth callout config for the system
operationId: enableAuthCallout
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthCalloutEnableRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Enable Auth Callout For System
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/auth-callout/authenticators:
get:
description: Get a list of authenticators available for use
operationId: listAuthCalloutAuthenticators
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthCalloutAuthenticatorsListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get List of Available Authenticators
tags:
- System
x-doc-tags:
- Auth Callout
/core/beta/systems/{systemId}/bulk/shares:
post:
description: allows sharing streams/exports across multiple accounts at once
operationId: bulkShare
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkShareRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Share assets across accounts
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/connections:
get:
operationId: listConnections
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
- explode: true
in: query
name: sort
required: false
schema:
type: string
style: form
- explode: true
in: query
name: account
required: false
schema:
type: string
style: form
- explode: true
in: query
name: cid
required: false
schema:
type: string
style: form
- explode: true
in: query
name: state
required: false
schema:
type: string
style: form
- explode: true
in: query
name: subject
required: false
schema:
type: string
style: form
- explode: true
in: query
name: limit
required: false
schema:
type: number
style: form
- explode: true
in: query
name: user
required: false
schema:
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SystemConnectionsListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Connections
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/export:
get:
operationId: getSystemExport
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SystemExportResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Export System Seeds
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/health/check:
get:
description: Returns overall health status of all servers in the system, similar to 'nats server report health'
operationId: getSystemHealthCheck
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get System Health Check
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/health/clusters:
get:
description: Returns cluster-level aggregated metrics and status information
operationId: getSystemHealthClusters
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterOverviewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Cluster Overview
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/health/jetstream:
get:
description: Returns JetStream health and usage statistics across all servers, similar to 'nats server report jetstream'
operationId: getSystemHealthJetstream
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JetStreamReportResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get JetStream Health Report
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/health/servers:
get:
description: Returns a list of all NATS servers in the system with their current status, similar to 'nats server ls'
operationId: getSystemHealthServers
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServerListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get System Server List
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/import-account:
post:
description: Imports an existing account
operationId: importAccount
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SystemAccountImportRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Import Account
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/import-user:
post:
description: Imports an existing NATS user
operationId: importUser
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SystemUserImportRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Import User
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/info/accounts:
get:
description: List info for Accounts within a System. Allows a user with access to a single account in a system to list info for all accounts in that system
operationId: listSystemInfoAccounts
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountInfoListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List System Accounts Info
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/info/servers:
get:
description: List info for NATS Servers within a System
operationId: listSystemInfoServers
parameters:
- explode: false
in: path
name: systemId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NatsServerInfoListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List System Servers info
tags:
- System
x-doc-tags:
- Systems
/core/beta/systems/{systemId}/jwt-sync:
post:
description: Use this endpoint to re-issue a
# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-system-api-openapi.yml