Synadia Communications

Synadia Communications Account API

The account API from Synadia Communications — 27 operation(s) for account.

GitHub OpenAPI

Operations 45

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/accounts/{accountId} Delete a NATS account · Delete Account #
Ask an LLM
“Can I permanently delete a NATS account from a system in Synadia Control Plane?”
“How do I remove an account I no longer need from its system?”
Tell an agent destructive · confirm first
Delete account {account}.
Remove NATS account {account} from its system for good.
GET /core/beta/accounts/{accountId} Look up a NATS account · Get Account #
Ask an LLM
“How do I fetch the details of one Synadia account by its ID?”
“What settings does a single NATS account record hold, like its auth type and JWT settings?”
Tell an agent
Show me account {account}.
Get the configuration of NATS account {account}.
PATCH /core/beta/accounts/{accountId} Update a NATS account's settings · Update Account #
Ask an LLM
“How do I rename an account or change its auth type?”
“Can I change how long user JWTs issued for an account stay valid?”
Tell an agent
Rename account {account} to {name}.
Set user JWTs on account {account} to expire after {seconds} seconds.
GET /core/beta/accounts/{accountId}/account-sk-groups List an account's signing key groups · List Account Signing Key Groups #
Ask an LLM
“Which signing key groups exist on a NATS account?”
“Where can I see every signing key group I've set up for an account?”
Tell an agent
List the signing key groups on account {account}.
Show me all signing key groups for account {account}.
POST /core/beta/accounts/{accountId}/account-sk-groups Create an account signing key group · Create Account Signing Key Group #
Ask an LLM
“How do I add a new signing key group to an account so users get scoped permissions?”
“Can I bring my own seed when creating a signing key group?”
Tell an agent
Create a signing key group named {name} on account {account}.
Add a programmatic={programmatic} signing key group {name} to account {account}.
GET /core/beta/accounts/{accountId}/alert-rules List an account's alert rules · List Account Alert Rules #
Ask an LLM
“What alert rules are configured on my NATS account?”
“Where do I see every alerting rule defined for an account?”
Tell an agent
List the alert rules on account {account}.
Show all alert rules configured for account {account}.
POST /core/beta/accounts/{accountId}/alert-rules Create an account alert rule · Create Account Alert Rule #
Ask an LLM
“How do I get alerted when a stream or consumer metric crosses a threshold?”
“Can an alert rule fire only after the condition holds for a certain number of seconds?”
Tell an agent
Create an alert on account {account} when {metric} is {operator} {value} for {seconds} seconds, severity {severity}, message {message}.
Add an alert rule on account {account} watching stream {stream} with severity {severity}.
DELETE /core/beta/accounts/{accountId}/alert-rules/{alertRuleId} Delete an account alert rule · Delete Account Alert Rule #
Ask an LLM
“Can I remove an alert rule I no longer need from an account?”
“Is deleting an alert rule different from just disabling it?”
Tell an agent destructive · confirm first
Delete alert rule {rule} from account {account}.
Remove the alert rule {rule} on account {account}.
GET /core/beta/accounts/{accountId}/alert-rules/{alertRuleId} Look up one account alert rule · Get Account Alert Rule #
Ask an LLM
“How can I view the threshold and severity of a specific alert rule?”
“What metric is a given alert rule watching?”
Tell an agent
Show alert rule {rule} on account {account}.
Get the definition of alert rule {rule} in account {account}.
PATCH /core/beta/accounts/{accountId}/alert-rules/{alertRuleId} Change an account alert rule · Update Account Alert Rule #
Ask an LLM
“How do I disable an existing alert rule without deleting it?”
“Can I change the threshold or severity on an alert rule I already created?”
Tell an agent
Disable alert rule {rule} on account {account} by setting enabled to {enabled}.
Change the severity of alert rule {rule} on account {account} to {severity}.
GET /core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run Test-run an account alert rule now · Run Account Alert Rule #
Ask an LLM
“Can I evaluate an alert rule on demand to see whether it would fire right now?”
“What comes back when I run an alert rule and its condition is met?”
Tell an agent
Run alert rule {rule} on account {account} and tell me if it triggers.
Evaluate alert rule {rule} for account {account} right now.
GET /core/beta/accounts/{accountId}/app-users List app users with access to an account · List Account Team App Users #
Ask an LLM
“Which team members have been given access to a particular NATS account?”
“Who are the app users assigned to an account and what roles do they hold?”
Tell an agent
List the app users assigned to account {account}.
Show who has access to account {account}.
DELETE /core/beta/accounts/{accountId}/app-users/{teamAppUserId} Remove a team member from an account · Unassign Team App User from Account #
Ask an LLM
“How do I revoke a teammate's access to one NATS account?”
“Can I unassign an app user from an account without removing them from the team?”
Tell an agent destructive · confirm first
Unassign app user {user} from account {account}.
Take away app user {user}'s access to account {account}.
POST /core/beta/accounts/{accountId}/app-users/{teamAppUserId} Grant a team member a role on an account · Assign Team App User to Account #
Ask an LLM
“How do I give a teammate access to a specific NATS account with a role?”
“If a user is already assigned to an account, can I just change their role?”
Tell an agent
Assign app user {user} to account {account} with role {role}.
Change app user {user}'s role on account {account} to {role}.
GET /core/beta/accounts/{accountId}/connections List live client connections on an account · List Account Connections #
Ask an LLM
“Which clients are connected to my NATS account right now?”
“Can I filter an account's connections by state, subject or NATS user?”
Tell an agent
List connections on account {account}.
Show connections on account {account} in state {state}, up to {limit}.
GET /core/beta/accounts/{accountId}/export Export an account's seeds · Export Account Seeds #
Ask an LLM
“How can I export the signing seeds for a NATS account as a backup?”
“Is there a way to download an account's seed material?”
Tell an agent
Export the seeds for account {account}.
Download account {account}'s seed export.
GET /core/beta/accounts/{accountId}/info Get server-side info for an account · Get Account Info #
Ask an LLM
“What runtime info does the server report about a NATS account?”
“Where can I see an account's info as the NATS system sees it, beyond its settings?”
Tell an agent
Get account info for {account}.
Show the server-reported info for account {account}.
GET /core/beta/accounts/{accountId}/jetstream List all JetStream assets on an account · List JetStream Assets #
Ask an LLM
“What JetStream assets, of every kind, does an account have?”
“Can I get one overview of all streams, KV and object buckets in an account?”
Tell an agent
List every JetStream asset in account {account}.
Give me an overview of the JetStream assets on account {account}.
GET /core/beta/accounts/{accountId}/jetstream/kv-buckets List an account's KV buckets · List KV buckets #
Ask an LLM
“Which key-value buckets exist in a NATS account?”
“Where do I see all KV buckets set up under one account?”
Tell an agent
List the KV buckets in account {account}.
Show me all key-value buckets on account {account}.
POST /core/beta/accounts/{accountId}/jetstream/kv-buckets Create a KV bucket in an account · Create KV Bucket #
Ask an LLM
“How do I create a new key-value bucket under a NATS account?”
“Can I set how many historical values per key a KV bucket keeps when I create it?”
Tell an agent
Create KV bucket {bucket} in account {account} with {storage} storage.
Create KV bucket {bucket} on account {account} keeping {history} revisions per key.
GET /core/beta/accounts/{accountId}/jetstream/mirrors List an account's stream mirrors · List Mirrors #
Ask an LLM
“Which mirror streams exist in my NATS account?”
“Where can I see all the stream mirrors configured under an account?”
Tell an agent
List the mirrors in account {account}.
Show all mirror streams on account {account}.
POST /core/beta/accounts/{accountId}/jetstream/mirrors Create a mirror of a stream · Create Mirror #
Ask an LLM
“How do I create a mirror that copies another stream's messages?”
“Can a mirror use a different storage type or replica count than its origin stream?”
Tell an agent
Create mirror {name} in account {account} mirroring {mirror}.
Create mirror {name} on account {account} with {storage} storage and {replicas} replicas.
GET /core/beta/accounts/{accountId}/jetstream/object-buckets List an account's object store buckets · List Object buckets #
Ask an LLM
“Which object store buckets exist under a NATS account?”
“Where do I see every object bucket in an account?”
Tell an agent
List the object buckets in account {account}.
Show all object store buckets on account {account}.
POST /core/beta/accounts/{accountId}/jetstream/object-buckets Create an object store bucket · Create Object Bucket #
Ask an LLM
“How do I create an object store bucket for large files in a NATS account?”
“Can I cap the total size or age of objects when creating an object bucket?”
Tell an agent
Create object bucket {bucket} in account {account}.
Create object bucket {bucket} on account {account} limited to {max_bytes} bytes.
GET /core/beta/accounts/{accountId}/jetstream/placement-options See where JetStream assets can be placed · Get JetStream Placement Options #
Ask an LLM
“Which clusters or tags can I place a new stream on for an account?”
“What placement options are available before I create a JetStream asset?”
Tell an agent
Get the JetStream placement options for account {account}.
Show where account {account} can place streams and buckets.
GET /core/beta/accounts/{accountId}/jetstream/streams List an account's JetStream streams · List Streams #
Ask an LLM
“What JetStream streams exist in a NATS account?”
“Where can I list every stream under one account?”
Tell an agent
List the streams in account {account}.
Show me all JetStream streams on account {account}.
POST /core/beta/accounts/{accountId}/jetstream/streams Create a JetStream stream · Create Stream #
Ask an LLM
“How do I create a JetStream stream that captures a set of subjects?”
“Can I limit a new stream by message count, bytes and age at the same time?”
Tell an agent
Create stream {name} in account {account} capturing subjects {subjects}.
Create stream {name} on account {account} with {retention} retention and max age {max_age}.
GET /core/beta/accounts/{accountId}/metrics Get usage metrics for an account · Get Account Metrics #
Ask an LLM
“Where do I see message and connection metrics for one NATS account?”
“Can I pull an account's metrics to check how much it is being used?”
Tell an agent
Get the metrics for account {account}.
Show usage metrics for account {account}.
GET /core/beta/accounts/{accountId}/nats-core/websocket/view Watch a NATS subject live over WebSocket · Subscribe to a NATS Core subject over websockets #
Ask an LLM
“Can I subscribe to a NATS Core subject from a browser over WebSocket?”
“How do I tail the live messages on a subject in an account without setting up a client?”
Tell an agent
Open a WebSocket view of subject {subject} on account {account}.
Stream live messages on {subject} in account {account} to me.
DELETE /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic} Lift a NATS user NKey revocation · Delete a for a NATS User NKey #
Ask an LLM
“Can I undo a revocation so a NATS user's older credentials work again?”
“How do I remove a revocation entry from an account?”
Tell an agent destructive · confirm first
Remove the revocation for user NKey {nkey} on account {account}.
Lift the revocation on user NKey {nkey} in account {account}.
GET /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic} Check a NATS user NKey's revocation · Get Revocation for a NATS User NKey #
Ask an LLM
“How can I tell whether a NATS user's NKey has been revoked on an account?”
“What cutoff time is set on an existing user revocation?”
Tell an agent
Check whether user NKey {nkey} is revoked on account {account}.
Show the revocation for user NKey {nkey} in account {account}.
PUT /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic} Revoke credentials for a NATS user NKey · Create or Update Revocation for a NATS User NKey #
Ask an LLM
“How do I revoke every credential issued to a NATS user before a certain time?”
“What happens if I set the revocation cutoff to 0?”
Tell an agent destructive · confirm first
Revoke user NKey {nkey} on account {account} for credentials issued before {before}.
Revoke all current credentials for user NKey {nkey} in account {account} as of now, using cutoff {before}.
GET /core/beta/accounts/{accountId}/nats-users List NATS users in an account · List NATS Users #
Ask an LLM
“Which NATS users belong to an account?”
“Where can I see every NATS user created under one account?”
Tell an agent
List the NATS users in account {account}.
Show me all NATS users on account {account}.
POST /core/beta/accounts/{accountId}/nats-users Create a NATS user in an account · Create NATS User #
Ask an LLM
“How do I create a new NATS user tied to a signing key group?”
“Can I make a NATS user whose JWT expires after a set number of seconds?”
Tell an agent
Create NATS user {name} in account {account} under signing key group {sk_group}.
Create NATS user {name} on account {account} in group {sk_group} with a JWT lasting {seconds} seconds.
GET /core/beta/accounts/{accountId}/stream-exports List an account's stream exports · List Stream Exports #
Ask an LLM
“Which streams has my account exported for other accounts to use?”
“Where can I see the stream exports an account publishes?”
Tell an agent
List the stream exports of account {account}.
Show which streams account {account} exports.
POST /core/beta/accounts/{accountId}/stream-exports Export a stream to other accounts · Create Stream Export #
Ask an LLM
“How do I share a JetStream stream from one account so others can import it?”
“Can a stream export be public rather than shared with specific accounts?”
Tell an agent
Export stream {stream} from account {account}.
Export stream {stream} from account {account} with public set to {is_public}.
GET /core/beta/accounts/{accountId}/stream-imports List an account's stream imports · List Stream Imports #
Ask an LLM
“Which streams has my account imported from other accounts?”
“Where do I see the stream imports configured on an account?”
Tell an agent
List the stream imports on account {account}.
Show the streams account {account} imports.
POST /core/beta/accounts/{accountId}/stream-imports Import a stream from another account · Create Stream Import #
Ask an LLM
“How do I import a stream another account exported to me?”
“What subject prefixes do I need to set when importing a remote stream?”
Tell an agent
Import stream {stream} from account NKey {remote} into account {account} with deliver prefix {deliver_prefix} and JS prefix {js_prefix}.
Import public stream {stream} from {remote} into account {account}.
GET /core/beta/accounts/{accountId}/stream-imports/shared List stream exports shared with an account · List Shared Stream Exports #
Ask an LLM
“Which streams have other accounts shared with mine that I could import?”
“Where can I discover stream exports available to my account?”
Tell an agent
List the stream exports shared with account {account}.
Show which other accounts' streams account {account} is allowed to import.
GET /core/beta/accounts/{accountId}/subject-exports List an account's subject exports · List Subject Exports #
Ask an LLM
“Which subjects or services does my account export?”
“Where do I see the subject exports defined on an account?”
Tell an agent
List the subject exports of account {account}.
Show which subjects account {account} exports.
POST /core/beta/accounts/{accountId}/subject-exports Export a subject from an account · Create Subject Export #
Ask an LLM
“How do I export a subject or service so other accounts can import it?”
“Can I enable latency metrics with a sampling percentage on a subject export?”
Tell an agent
Create a subject export on account {account} with JWT settings {jwt_settings}.
Export a subject from account {account} with metrics enabled={metrics} sampled at {percent} percent.
GET /core/beta/accounts/{accountId}/subject-imports List an account's subject imports · List Subject Imports #
Ask an LLM
“Which subjects has my account imported from elsewhere?”
“Where are the subject imports for an account listed?”
Tell an agent
List the subject imports on account {account}.
Show the subjects account {account} imports.
POST /core/beta/accounts/{accountId}/subject-imports Import a subject into an account · Create Subject Import #
Ask an LLM
“How do I import a subject that another account exports?”
“What JWT settings does a subject import need?”
Tell an agent
Create a subject import on account {account} with JWT settings {jwt_settings}.
Import a subject into account {account} using {jwt_settings}.
GET /core/beta/accounts/{accountId}/subject-imports/shared List subject exports shared with an account · List Shared Subject Exports #
Ask an LLM
“Which subjects have other accounts shared with mine?”
“Where can I find subject exports that my account is allowed to import?”
Tell an agent
List the subject exports shared with account {account}.
Show other accounts' subjects that account {account} can import.
DELETE /core/beta/accounts/{accountId}/unmanage Stop managing an account in Control Plane · Unmanage Account #
Ask an LLM
“Can I detach an account from Synadia Control Plane management without deleting it?”
“How do I hand an account back so the Control Plane no longer manages it?”
Tell an agent destructive · confirm first
Unmanage account {account}.
Stop Control Plane from managing account {account}.

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-account-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/synadia-io/control-plane-sdk-go
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/apis.yml

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-account-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-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Account 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 (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-account-api-openapi.yml