Synadia Communications Account API
The account API from Synadia Communications — 27 operation(s) for account.
The account API from Synadia Communications — 27 operation(s) for account.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/synadia-communications-account-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 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:
- name: Account
paths:
/core/beta/accounts/{accountId}:
delete:
description: Deletes a Account in a system
operationId: deleteAccount
parameters:
- explode: false
in: path
name: accountId
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
'422':
description: Unprocessable
summary: Delete Account
tags:
- Account
x-doc-tags:
- Accounts
get:
description: Returns a Account by ID
operationId: getAccount
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
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: Get Account
tags:
- Account
x-doc-tags:
- Accounts
patch:
description: Updates a Account in a system
operationId: updateAccount
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountUpdateRequest'
responses:
'200':
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: Update Account
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/account-sk-groups:
get:
operationId: listAccountSkGroup
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SigningKeyGroupListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Account Signing Key Groups
tags:
- Account
x-doc-tags:
- Signing Key Groups
post:
description: Creates Account Signing Key Group
operationId: createAccountSkGroup
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SigningKeyGroupCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SigningKeyGroupCreateResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create Account Signing Key Group
tags:
- Account
x-doc-tags:
- Signing Key Groups
/core/beta/accounts/{accountId}/alert-rules:
get:
operationId: listAlertRules
parameters:
- explode: false
in: path
name: accountId
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 Account Alert Rules
tags:
- Account
x-doc-tags:
- Alerts
post:
description: Creates Account Alert Rule
operationId: createAlertRule
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleAccountCreateRequest'
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 Account Alert Rule
tags:
- Account
x-doc-tags:
- Alerts
/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}:
delete:
description: Deletes Account alert rule
operationId: deleteAlertRule
parameters:
- explode: false
in: path
name: accountId
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 Account Alert Rule
tags:
- Account
x-doc-tags:
- Alerts
get:
operationId: getAlertRule
parameters:
- explode: false
in: path
name: accountId
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 Account Alert Rule
tags:
- Account
x-doc-tags:
- Alerts
patch:
operationId: updateAlertRule
parameters:
- explode: false
in: path
name: accountId
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 Account Alert Rule
tags:
- Account
x-doc-tags:
- Alerts
/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run:
get:
description: Run Account Alert Rule and return an alert object if the rule condition is met
operationId: runAlertRule
parameters:
- explode: false
in: path
name: accountId
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 Account Alert Rule
tags:
- Account
x-doc-tags:
- Alerts
/core/beta/accounts/{accountId}/app-users:
get:
description: Returns a list of Team App Users associated with the Account
operationId: listAccountTeamAppUsers
parameters:
- explode: false
in: path
name: accountId
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 Account Team App Users
tags:
- Account
x-doc-tags:
- App Users
/core/beta/accounts/{accountId}/app-users/{teamAppUserId}:
delete:
description: Unassign a Team App User from an Account
operationId: unAssignAccountTeamAppUser
parameters:
- explode: false
in: path
name: accountId
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 Account
tags:
- Account
x-doc-tags:
- App Users
post:
description: Assign a Team App User to an Account. This operation is idempotent; if an App User is already assigned to the Account the assignemnt will be updated with the new role
operationId: assignAccountTeamAppUser
parameters:
- explode: false
in: path
name: accountId
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 Account
tags:
- Account
x-doc-tags:
- App Users
/core/beta/accounts/{accountId}/connections:
get:
operationId: listAccountConnections
parameters:
- explode: false
in: path
name: accountId
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: 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/AccountConnectionsListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Account Connections
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/export:
get:
operationId: getAccountExport
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountExportResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Export Account Seeds
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/info:
get:
description: Returns Account info
operationId: getAccountInfo
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSAcctStats'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Account Info
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/jetstream:
get:
operationId: listJetStreamAssets
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSStreamInfoListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List JetStream Assets
tags:
- Account
x-doc-tags:
- JetStream
/core/beta/accounts/{accountId}/jetstream/kv-buckets:
get:
operationId: listKvBuckets
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSKVBucketListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List KV buckets
tags:
- Account
x-doc-tags:
- 'JetStream: KV Buckets'
post:
description: Creates KV Bucket
operationId: createKvBucket
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JSKVBucketConfig'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/JSKVBucketViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create KV Bucket
tags:
- Account
x-doc-tags:
- 'JetStream: KV Buckets'
/core/beta/accounts/{accountId}/jetstream/mirrors:
get:
operationId: listMirrors
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSMirrorInfoListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Mirrors
tags:
- Account
x-doc-tags:
- 'JetStream: Mirrors'
post:
description: Creates Mirror
operationId: createMirror
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JSMirrorConfigRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSMirrorInfoResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create Mirror
tags:
- Account
x-doc-tags:
- 'JetStream: Mirrors'
/core/beta/accounts/{accountId}/jetstream/object-buckets:
get:
operationId: listObjectBuckets
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSObjectBucketListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Object buckets
tags:
- Account
x-doc-tags:
- 'JetStream: Object Buckets'
post:
description: Creates Object Bucket
operationId: createObjectBucket
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JSObjectBucketConfig'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/JSObjectBucketViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create Object Bucket
tags:
- Account
x-doc-tags:
- 'JetStream: Object Buckets'
/core/beta/accounts/{accountId}/jetstream/placement-options:
get:
description: Get available options for JetStream placement
operationId: getJetStreamPlacementOptions
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSPlacementOptionsResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get JetStream Placement Options
tags:
- Account
x-doc-tags:
- JetStream
/core/beta/accounts/{accountId}/jetstream/streams:
get:
operationId: listStreams
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JSStreamInfoListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Streams
tags:
- Account
x-doc-tags:
- 'JetStream: Streams'
post:
operationId: createStream
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JSStreamConfigRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/JSStreamInfoResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create Stream
tags:
- Account
x-doc-tags:
- 'JetStream: Streams'
/core/beta/accounts/{accountId}/metrics:
get:
description: Returns Account metrics
operationId: getAccountMetrics
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMetrics'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Account Metrics
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/nats-core/websocket/view:
get:
description: 'This endpoint enables connection to NATS over WebSocket using account credentials.
It generates a user JWT from the account signing key and acts as a proxy to establish a connection with the first NATS server defined in a System.
Options specified in the CONNECT request from client take priority, so the caller should avoid including authentication information in CONNECT to leverage automatic JWT injection.
As a proxy, direct connection to NATS servers may be unavailable for the caller.
Hence, it''s advised to disregard all server update messages.
In nats.ws, achieve this by setting ''ignoreClusterUpdates'' to true.'
operationId: natsCoreWebsocketViewer
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
- explode: true
in: query
name: subject
required: true
schema:
type: string
style: form
responses:
'101':
description: Switching Protocols
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Subscribe to a NATS Core subject over websockets
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}:
delete:
description: Deletes a Revocation for the given NATS User NKey
operationId: deleteNatsUserRevocation
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: userNkeyPublic
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 a for a NATS User NKey
tags:
- Account
x-doc-tags:
- Accounts
get:
description: Get Revocation for the given NATS User NKey
operationId: getNatsUserRevocation
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: userNkeyPublic
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserRevocationViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Get Revocation for a NATS User NKey
tags:
- Account
x-doc-tags:
- Accounts
put:
description: Creates or Updates a Revocation for the given NATS User NKey. All users issued prior to 'before' will be revoked. If 'before' is set to 0, the current timestamp will be used.
operationId: createOrUpdateNatsUserRevocation
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: userNkeyPublic
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserRevocationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserRevocationViewResponse'
description: Success
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserRevocationViewResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: Create or Update Revocation for a NATS User NKey
tags:
- Account
x-doc-tags:
- Accounts
/core/beta/accounts/{accountId}/nats-users:
get:
description: Returns a list of NATS users for the given account
operationId: listUsers
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List NATS Users
tags:
- Account
x-doc-tags:
- NATS Users
post:
description: Creates a NATS user for an account
operationId: createUser
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NatsUserCreateRequest'
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: Create NATS User
tags:
- Account
x-doc-tags:
- NATS Users
/core/beta/accounts/{accountId}/stream-exports:
get:
operationId: listStreamExports
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StreamExportListResponse'
description: Success
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
summary: List Stream Exports
tags:
- Account
x-doc-tags:
- Sharing
post:
description: Creates Stream Export
operationId: createStreamExport
parameters:
- explode: false
in: path
name: accountId
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreamExportCreateRequest'
responses:
'201':
content:
application/json:
# --- 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