Synadia Communications

Synadia Communications System API

The system API from Synadia Communications — 35 operation(s) for system.

GitHub OpenAPI

Operations 44

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /core/beta/systems/{systemId} Delete a system · Delete System #
Ask an LLM
“What happens to the accounts when I delete a whole system?”
“Can I permanently remove a NATS system and purge it from the servers?”
Tell an agent destructive · confirm first
Delete system {systemId} and purge it from NATS.
Remove system {systemId} entirely.
GET /core/beta/systems/{systemId} Get a NATS system's details · Get System #
Ask an LLM
“What connection settings and JetStream domain does my NATS system have?”
“Can I look up a single system by its ID to see its URL and name?”
Tell an agent
Show me the details of system {systemId}.
Fetch the configuration for NATS system {systemId}.
PATCH /core/beta/systems/{systemId} Update a system's settings · Update System #
Ask an LLM
“Can I change a system's server URL and test the connection before saving?”
“Is it possible to turn on JetStream or set the JetStream domain on an existing system?”
Tell an agent
Rename system {systemId} to {name}.
Point system {systemId} at {url}.
GET /core/beta/systems/{systemId}/accounts List accounts in a system · List Accounts #
Ask an LLM
“Which NATS accounts exist in my system?”
“Can I see every account that belongs to one system?”
Tell an agent
List the accounts in system {systemId}.
Show all NATS accounts under system {systemId}.
POST /core/beta/systems/{systemId}/accounts Create an account in a system · Create Account #
Ask an LLM
“How do I add a new NATS account to my system?”
“Can I set how long user JWTs last when creating an account?”
Tell an agent
Create an account named {name} in system {systemId}.
Add account {name} to system {systemId} with user JWTs expiring after {user_jwt_expires_in_secs} seconds.
GET /core/beta/systems/{systemId}/accounts-overview-metrics Get overview metrics for a system's accounts · List Accounts overview metrics #
Ask an LLM
“What are the usage metrics across all accounts in my system?”
“Is there a dashboard-style summary of account activity for one system?”
Tell an agent
Show the accounts overview metrics for system {systemId}.
Pull per-account summary metrics for system {systemId}.
GET /core/beta/systems/{systemId}/agent-tokens List dataplane agent tokens · List Agent Tokens #
Ask an LLM
“Which agent tokens have been issued for my system's dataplane agent?”
“Can I see the history of agent tokens for a system?”
Tell an agent
List the agent tokens for system {systemId}.
Show all dataplane agent tokens issued for system {systemId}.
POST /core/beta/systems/{systemId}/agent-tokens Rotate the dataplane agent token · Rotate Agent Token #
Ask an LLM
“How do I rotate the token my dataplane agent uses to connect?”
“Can I issue a fresh agent token if the old one leaked?”
Tell an agent
Rotate the agent token for system {systemId}.
Generate a new dataplane agent connection token for system {systemId}.
GET /core/beta/systems/{systemId}/agent-tokens/current Get the current agent token · Get Current Agent Token #
Ask an LLM
“Which agent token is currently active for my system?”
“Where can I copy the live token for connecting the dataplane agent?”
Tell an agent
Get the current agent token for system {systemId}.
Show me the active dataplane agent token on system {systemId}.
GET /core/beta/systems/{systemId}/alert-rules List a system's alert rules · List System Alert Rules #
Ask an LLM
“What alert rules are configured on my system?”
“Can I see every metric threshold alert set up for one system?”
Tell an agent
List the alert rules for system {systemId}.
Show all configured alerts on system {systemId}.
POST /core/beta/systems/{systemId}/alert-rules Create an alert rule on a system · Create System Alert Rule #
Ask an LLM
“Can I get alerted when a metric crosses a threshold for a set duration?”
“What severity levels and threshold operators can a new system alert use?”
Tell an agent
Alert {severity} on system {systemId} when {metric} {threshold_operator} {threshold_fixed_value} for {duration_in_secs}s, saying {message}.
Add a {severity} alert rule to system {systemId} watching {metric}.
DELETE /core/beta/systems/{systemId}/alert-rules/{alertRuleId} Delete a system alert rule · Delete System Alert Rule #
Ask an LLM
“Can I remove an alert rule I no longer need?”
“What's the way to stop and delete one system alert permanently?”
Tell an agent destructive · confirm first
Delete alert rule {alertRuleId} from system {systemId}.
Remove the alert {alertRuleId} on system {systemId}.
GET /core/beta/systems/{systemId}/alert-rules/{alertRuleId} Get a system alert rule · Get System Alert Rule #
Ask an LLM
“What threshold and severity does a specific alert rule use?”
“Can I view one alert rule's configuration by its ID?”
Tell an agent
Show alert rule {alertRuleId} on system {systemId}.
Get the settings of alert rule {alertRuleId} in system {systemId}.
PATCH /core/beta/systems/{systemId}/alert-rules/{alertRuleId} Update or disable a system alert rule · Update System Alert Rules #
Ask an LLM
“Can I temporarily disable an alert rule without deleting it?”
“Is it possible to change an existing alert's threshold or severity?”
Tell an agent
Set alert rule {alertRuleId} on system {systemId} to enabled={is_enabled}.
Change the severity of alert rule {alertRuleId} in system {systemId} to {severity}.
GET /core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run Evaluate an alert rule now · Run System Alert Rule #
Ask an LLM
“Can I test whether an alert rule's condition is met right now?”
“Does evaluating an alert rule on demand return the alert it would fire?”
Tell an agent
Run alert rule {alertRuleId} on system {systemId} and tell me if it fires.
Evaluate alert {alertRuleId} for system {systemId} now.
GET /core/beta/systems/{systemId}/app-users List app users with access to a system · List System Team App Users #
Ask an LLM
“Which team members have been given access to this system?”
“Can I see the app users assigned to a system and their roles?”
Tell an agent
List the app users assigned to system {systemId}.
Show who has access to system {systemId}.
DELETE /core/beta/systems/{systemId}/app-users/{teamAppUserId} Remove an app user's access to a system · Unassign Team App User from System #
Ask an LLM
“Can I revoke one person's access to a system but keep them on the team?”
“What's the way to unassign an app user from a system?”
Tell an agent destructive · confirm first
Unassign app user {teamAppUserId} from system {systemId}.
Revoke {teamAppUserId}'s access to system {systemId}.
POST /core/beta/systems/{systemId}/app-users/{teamAppUserId} Grant a team app user a role on a system · Assign Team App User to System #
Ask an LLM
“How do I give a teammate access to a specific system?”
“Will reassigning someone already on the system just update their role?”
Tell an agent
Assign app user {teamAppUserId} to system {systemId} with role {role_id}.
Change {teamAppUserId}'s role on system {systemId} to {role_id}.
GET /core/beta/systems/{systemId}/audit/jobs List recent audit jobs for a system · List Audit Jobs #
Ask an LLM
“What audit checks have been run on my system recently?”
“Can I see past audit jobs newest first?”
Tell an agent
List recent audit jobs for system {systemId}.
Show the audit job history on system {systemId}.
GET /core/beta/systems/{systemId}/audit/jobs/{jobId} Check an audit job's status · Get Audit Job Status #
Ask an LLM
“Is my system audit still running or has it finished?”
“Can I poll the progress of an asynchronous audit job?”
Tell an agent
Check the status of audit job {jobId} on system {systemId}.
Tell me whether audit job {jobId} for system {systemId} is done.
GET /core/beta/systems/{systemId}/audit/jobs/{jobId}/result Get the results of a completed audit · Get Audit Job Result #
Ask an LLM
“Where can I read the findings of a finished system audit?”
“What did the audit check report about my servers and accounts?”
Tell an agent
Get the results of audit job {jobId} on system {systemId}.
Show the analyzed audit findings for job {jobId} in system {systemId}.
POST /core/beta/systems/{systemId}/audit/run Start a system audit check · Run System Audit Check #
Ask an LLM
“Can I run an audit of my NATS servers and accounts against check profiles?”
“Does starting an audit return a job I can track?”
Tell an agent
Start an audit on system {systemId} using profiles {profiles} against servers {server_endpoints} and accounts {account_endpoints}.
Run a system audit check on {systemId}.
GET /core/beta/systems/{systemId}/auth-callout List a system's auth callout configs · List Auth Callout Configs #
Ask an LLM
“Which auth callout configurations exist for my system?”
“Has auth callout already been enabled on this system?”
Tell an agent
List the auth callout configs for system {systemId}.
Show auth callout setups on system {systemId}.
POST /core/beta/systems/{systemId}/auth-callout Enable auth callout on a system · Enable Auth Callout For System #
Ask an LLM
“How do I turn on auth callout so an external service authenticates users?”
“Which control account should handle auth callout for my system?”
Tell an agent
Enable auth callout on system {systemId} using control account {control_account}.
Set {control_account} as the auth callout control account for system {systemId}.
GET /core/beta/systems/{systemId}/auth-callout/authenticators List available auth callout authenticators · Get List of Available Authenticators #
Ask an LLM
“What authenticators can I plug into auth callout?”
“Which authentication backends are available for a system's auth callout?”
Tell an agent
List the available authenticators for system {systemId}.
Show which auth callout authenticators system {systemId} can use.
POST /core/beta/systems/{systemId}/bulk/shares Share a stream or export with many accounts · Share assets across accounts #
Ask an LLM
“Can I share one stream with several accounts at once?”
“Is there a bulk way to share an export across accounts instead of one by one?”
Tell an agent
Share {type} {id} in system {systemId} with accounts {target_accounts}.
Bulk-share asset {id} of type {type} to accounts {target_accounts} on system {systemId}.
GET /core/beta/systems/{systemId}/connections List client connections in a system · List Connections #
Ask an LLM
“Which clients are connected to my NATS system right now?”
“Can I filter connections by account, user, subject or state?”
Tell an agent
List connections on system {systemId} for account {account}.
Show the {limit} connections on system {systemId} for user {user}, sorted by {sort}.
GET /core/beta/systems/{systemId}/export Export a system's seeds · Export System Seeds #
Ask an LLM
“Can I export the operator and account seeds for a system as a backup?”
“Where do I download a system's seed export?”
Tell an agent
Export the seeds for system {systemId}.
Download system {systemId}'s seed backup.
GET /core/beta/systems/{systemId}/health/check Check overall server health in a system · Get System Health Check #
Ask an LLM
“Are all the servers in my system healthy?”
“Is there an equivalent of 'nats server report health' over the API?”
Tell an agent
Run a health check on system {systemId}.
Report the overall server health for system {systemId}.
GET /core/beta/systems/{systemId}/health/clusters Get cluster-level health overview · Get Cluster Overview #
Ask an LLM
“What's the aggregated status of each cluster in my system?”
“Can I see cluster-level metrics rather than per-server stats?”
Tell an agent
Show the cluster health overview for system {systemId}.
Summarize cluster status and metrics in system {systemId}.
GET /core/beta/systems/{systemId}/health/jetstream Get the JetStream health report · Get JetStream Health Report #
Ask an LLM
“How much JetStream storage and memory is in use across my servers?”
“Is there an API version of 'nats server report jetstream'?”
Tell an agent
Get the JetStream health report for system {systemId}.
Show JetStream usage per server in system {systemId}.
GET /core/beta/systems/{systemId}/health/servers List servers with their health status · Get System Server List #
Ask an LLM
“Which NATS servers in my system are up, and what's their current status?”
“Can I get the 'nats server ls' view through the API?”
Tell an agent
List servers with health status for system {systemId}.
Show the server status list for system {systemId}.
POST /core/beta/systems/{systemId}/import-account Import an existing account · Import Account #
Ask an LLM
“Can I bring an existing NATS account into a system using its JWT and seed?”
“Is it possible to include signing keys when importing an account?”
Tell an agent
Import the account with JWT {jwt} and seed {seed} into system {systemId}.
Import an existing account into system {systemId} along with signing keys {signing_keys}.
POST /core/beta/systems/{systemId}/import-user Import an existing NATS user · Import User #
Ask an LLM
“Can I import a NATS user I created outside the platform?”
“Is a creds file enough to import a user, or do I need the JWT and seed?”
Tell an agent
Import a NATS user into system {systemId} from credential {credential}.
Import the user with JWT {jwt} and seed {seed} into system {systemId}.
GET /core/beta/systems/{systemId}/info/accounts List basic info for all accounts in a system · List System Accounts Info #
Ask an LLM
“If I only have access to one account, can I still see info about the others in the system?”
“Where do I get the names and IDs of every account in a system?”
Tell an agent
List account info for all accounts in system {systemId}.
Show summary info for every account in system {systemId}.
GET /core/beta/systems/{systemId}/info/servers List basic info for a system's servers · List System Servers info #
Ask an LLM
“What server info is visible for the NATS servers in my system?”
“Can I get a lightweight info list of servers in a system?”
Tell an agent
List server info for system {systemId}.
Show the info records for NATS servers in system {systemId}.
POST /core/beta/systems/{systemId}/jwt-sync Re-issue all account JWTs in a system · Re-sync JWTs of all accounts in this system #
Ask an LLM
“Can I force every account JWT in a system to be re-issued?”
“How long does a system-wide JWT resync take to finish?”
Tell an agent
Re-sync all account JWTs in system {systemId}.
Mark every account JWT in system {systemId} for renewal.
GET /core/beta/systems/{systemId}/limits Get a system's total and allocated limits · Get System Limits #
Ask an LLM
“How much of my system's limits have I already allocated to accounts?”
“What are the total resource limits for a system?”
Tell an agent
Show the limits for system {systemId}.
Show how much capacity is unallocated in system {systemId}.
GET /core/beta/systems/{systemId}/nats-clusters List NATS clusters in a system · List Clusters #
Ask an LLM
“Which NATS clusters make up my system?”
“Can I list cluster information for one system?”
Tell an agent
List the NATS clusters in system {systemId}.
Show cluster information for system {systemId}.
PATCH /core/beta/systems/{systemId}/platform-components Enable or configure a platform component · Update Platform Components for System #
Ask an LLM
“Can I enable or disable a platform component on my system?”
“Where do I change the config for a system's platform components?”
Tell an agent
Set platform component {type} on system {systemId} to enabled={enabled}.
Update the {type} component config on system {systemId} to {config}.
GET /core/beta/systems/{systemId}/platform-components/{id}/tokens Get an access token for a platform component · Get a component access token #
Ask an LLM
“How does a platform component get the token it needs to connect?”
“Can I retrieve the access token for one of my system's components?”
Tell an agent
Get the access token for platform component {id} on system {systemId}.
Retrieve component {id}'s token in system {systemId}.
GET /core/beta/systems/{systemId}/prometheus-metrics Get Prometheus metrics for a system · Get Prometheus Metrics #
Ask an LLM
“Can I scrape my system's metrics in Prometheus format?”
“Where do I get Prometheus metrics for a NATS system?”
Tell an agent
Get the Prometheus metrics for system {systemId}.
Pull system {systemId}'s metrics in Prometheus exposition format.
GET /core/beta/systems/{systemId}/servers List servers in a system · List Servers #
Ask an LLM
“What server information is recorded for each server in my system?”
“Can I list the raw server records for a system?”
Tell an agent
List the servers in system {systemId}.
Give me the server information records for system {systemId}.
DELETE /core/beta/systems/{systemId}/unmanage Stop managing a system without purging NATS · Unmanage System #
Ask an LLM
“Can I remove a system from management but leave its accounts running in NATS?”
“What's the difference between unmanaging a system and deleting it?”
Tell an agent destructive · confirm first
Unmanage system {systemId} without purging its accounts.
Detach system {systemId} from the control plane but keep it in NATS.

Documentation

📖
Documentation
https://docs.synadia.com/platform/control-plane
📖
APIReference
https://cloud.synadia.com/api-docs
📖
Documentation
https://docs.synadia.com/cloud/resources/http-gateway
📖
APIReference
https://api.ngs.global/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-system-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/synadia-io/control-plane-sdk-go

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/synadia-communications: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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

synadia-communications-system-api-openapi.yml Raw ↑ 
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:


# --- 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