How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Synadia Communications

Synadia Control Plane / Synadia Cloud API

The REST control-plane API behind Synadia Cloud and the self-hosted Synadia Control Plane. 245 operations across 158 paths manage systems, accounts, teams, NATS users, JetStream streams, consumers, key-value and object buckets, mirrors, imports/exports, signing key groups, auth callout, OIDC providers, alerts, workloads and licensing. Authenticated with a Personal Access Token as an HTTP bearer token, or a session cookie in the console.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 245 operations across 158 paths, organized into 34 resource areas, and defines 487 schemas. It is described by OpenAPI 3.0.0, at version beta.

Requests are made against a single base URL, {baseUrl}/api.

245 operations 158 paths 487 schemas 43 DELETE113 GET26 PATCH61 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
beta
Base URL
https://cloud.synadia.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
34

Authentication & Security 2

Synadia Control Plane / Synadia Cloud API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (Personal Access Token) (bearerAuth). An API key is passed in the cookie as control_plane_session (sessionAuth). By default, every request must be authenticated.

Paths & Operations 245

Across 158 paths, the API surfaces 245 operations — 43 DELETE, 113 GET, 26 PATCH, 61 POST, 2 PUT. They span 34 resource areas, including sig-key-group, sig-key, account, admin, agent-token, session, alert, app-user, and 26 more. Each is listed below with its method, path, parameters, and response codes.

sig-key-group 7
DELETE
/core/beta/account-sk-groups/{groupId}
Delete Account Signing Key Group
deleteAccountSkGroup 1 param → 204400401403404
GET
/core/beta/account-sk-groups/{groupId}
Get Account Signing Key Group
getAccountSkGroup 1 param → 200400401403404
PATCH
/core/beta/account-sk-groups/{groupId}
Update Account Signing Key Group
updateAccountSkGroup 1 param body → 200400401403404
GET
/core/beta/account-sk-groups/{groupId}/account-sks
List Signing Keys
listAccountSkGroupKeys 1 param → 200400401403404
POST
/core/beta/account-sk-groups/{groupId}/copy
Copy Account SK Group
copyAccountSkGroup 1 param body → 200400401403404
GET
/core/beta/account-sk-groups/{groupId}/nats-users
List NATS Users
listAccountSKGroupUsers 1 param → 200400401403404
POST
/core/beta/account-sk-groups/{groupId}/rotate-sk
Roate Active Signing Key
rotateAccountSk 1 param → 200400401403404
sig-key 3
DELETE
/core/beta/account-sks/{keyId}
Delete Account Signing
deleteAccountSk 1 param → 204400401403404
GET
/core/beta/account-sks/{keyId}
Get Account Signing
getAccountSk 1 param → 200400401403404
PATCH
/core/beta/account-sks/{keyId}
Update Account Signing
updateAccountSk 1 param body → 200400401403404
account 45
DELETE
/core/beta/accounts/{accountId}
Delete Account
deleteAccount 1 param → 204400401403404422
GET
/core/beta/accounts/{accountId}
Get Account
getAccount 1 param → 200400401403404
PATCH
/core/beta/accounts/{accountId}
Update Account
updateAccount 1 param body → 200400401403404
GET
/core/beta/accounts/{accountId}/account-sk-groups
List Account Signing Key Groups
listAccountSkGroup 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/account-sk-groups
Create Account Signing Key Group
createAccountSkGroup 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/alert-rules
List Account Alert Rules
listAlertRules 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/alert-rules
Create Account Alert Rule
createAlertRule 1 param body → 200400401403404
DELETE
/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}
Delete Account Alert Rule
deleteAlertRule 2 params → 204400401403404
GET
/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}
Get Account Alert Rule
getAlertRule 2 params → 200400401403404
PATCH
/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}
Update Account Alert Rule
updateAlertRule 2 params body → 200400401403404
GET
/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run
Run Account Alert Rule
runAlertRule 2 params → 200400401403404
GET
/core/beta/accounts/{accountId}/app-users
List Account Team App Users
listAccountTeamAppUsers 1 param → 200400401403404
DELETE
/core/beta/accounts/{accountId}/app-users/{teamAppUserId}
Unassign Team App User from Account
unAssignAccountTeamAppUser 2 params → 204400401403404
POST
/core/beta/accounts/{accountId}/app-users/{teamAppUserId}
Assign Team App User to Account
assignAccountTeamAppUser 2 params body → 201400401403404
GET
/core/beta/accounts/{accountId}/connections
List Account Connections
listAccountConnections 7 params → 200400401403404
GET
/core/beta/accounts/{accountId}/export
Export Account Seeds
getAccountExport 1 param → 200400401403404
GET
/core/beta/accounts/{accountId}/info
Get Account Info
getAccountInfo 1 param → 200400401403404
GET
/core/beta/accounts/{accountId}/jetstream
List JetStream Assets
listJetStreamAssets 1 param → 200400401403404
GET
/core/beta/accounts/{accountId}/jetstream/kv-buckets
List KV buckets
listKvBuckets 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/jetstream/kv-buckets
Create KV Bucket
createKvBucket 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/jetstream/mirrors
List Mirrors
listMirrors 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/jetstream/mirrors
Create Mirror
createMirror 1 param body → 200400401403404
GET
/core/beta/accounts/{accountId}/jetstream/object-buckets
List Object buckets
listObjectBuckets 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/jetstream/object-buckets
Create Object Bucket
createObjectBucket 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/jetstream/placement-options
Get JetStream Placement Options
getJetStreamPlacementOptions 1 param → 200400401403404
GET
/core/beta/accounts/{accountId}/jetstream/streams
List Streams
listStreams 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/jetstream/streams
Create Stream
createStream 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/metrics
Get Account Metrics
getAccountMetrics 1 param → 200400401403404
GET
/core/beta/accounts/{accountId}/nats-core/websocket/view
Subscribe to a NATS Core subject over websockets
natsCoreWebsocketViewer 2 params → 101400401403404
DELETE
/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}
Delete a for a NATS User NKey
deleteNatsUserRevocation 2 params → 204400401403404
GET
/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}
Get Revocation for a NATS User NKey
getNatsUserRevocation 2 params → 200400401403404
PUT
/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}
Create or Update Revocation for a NATS User NKey
createOrUpdateNatsUserRevocation 2 params body → 200201400401403404
GET
/core/beta/accounts/{accountId}/nats-users
List NATS Users
listUsers 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/nats-users
Create NATS User
createUser 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/stream-exports
List Stream Exports
listStreamExports 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/stream-exports
Create Stream Export
createStreamExport 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/stream-imports
List Stream Imports
listStreamImports 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/stream-imports
Create Stream Import
createStreamImport 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/stream-imports/shared
List Shared Stream Exports
listStreamExportsShared 1 param → 200400401403404
GET
/core/beta/accounts/{accountId}/subject-exports
List Subject Exports
listSubjectExports 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/subject-exports
Create Subject Export
createSubjectExport 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/subject-imports
List Subject Imports
listSubjectImports 1 param → 200400401403404
POST
/core/beta/accounts/{accountId}/subject-imports
Create Subject Import
createSubjectImport 1 param body → 201400401403404
GET
/core/beta/accounts/{accountId}/subject-imports/shared
List Shared Subject Exports
listSubjectExportsShared 1 param → 200400401403404
DELETE
/core/beta/accounts/{accountId}/unmanage
Unmanage Account
unmanageAccount 1 param → 204400401403404
admin 2
GET
/core/beta/admin/app-user
Check for Admin User
checkAppAdmin → 204400401403404
POST
/core/beta/admin/app-user
Create an App Admin User
createAppAdmin body → 201400401403404
agent-token 1
DELETE
/core/beta/agent-tokens/{tokenId}
Delete Agent Token
deleteAgentToken 1 param → 204400401403404
session 13
GET
/core/beta/alerts
List Alerts
listAlerts 1 param → 200400401403404
GET
/core/beta/app-users
List App Users
listAppUsers → 200400401403404
POST
/core/beta/app-users
Create App User
createAppUser body → 200400401403404
GET
/core/beta/invitations
List of pending invitations
listInvitations → 200400401403404
POST
/core/beta/invitations/{teamId}
Accept or reject team invitation
decideInvitation 1 param body → 204400401403404
GET
/core/beta/personal-access-tokens
List Personal Access Tokens
listAppUserAccessTokens → 200400401403404
POST
/core/beta/personal-access-tokens
Create Personal Access Token
createAppUserAccessToken body → 201400401403404
GET
/core/beta/service-accounts/app
List App Service Accounts
listAppServiceAccounts → 200400401403404
POST
/core/beta/service-accounts/app
Create App Service Account
createAppServiceAccount body → 200400401403404
GET
/core/beta/teams
List Teams
listTeams 1 param → 200400401403404
POST
/core/beta/teams
Create Team
createTeam body → 200400401403404
POST
/core/beta/terms/accept
Accept terms
acceptTerms → 201400401403404
GET
/core/beta/version
Get Version
getVersion → 200400401403404
alert 2
GET
/core/beta/alerts/{alertId}
Get Alert
getAlert 1 param → 200400401403404
PATCH
/core/beta/alerts/{alertId}/acknowledge
Acknowledge Alert
acknowledgeAlert 1 param → 204400401403404
app-user 5
DELETE
/core/beta/app-users/{appUserId}
Delete App User
deleteAppUser 1 param → 204400401403404
GET
/core/beta/app-users/{appUserId}
Get App User
getAppUser 1 param → 200400401403404
PATCH
/core/beta/app-users/{appUserId}
Update App User
updateAppUser 1 param body → 200400401403404
GET
/core/beta/app-users/{appUserId}/roles
List Roles
listAppUserRoles 1 param → 200400401403404
POST
/core/beta/app-users/{appUserId}/teams/{teamId}
Assign App User to Team
assignTeamAppUser 2 params body → 201400401403404
auth-callout 8
DELETE
/core/beta/auth-callout/{authCalloutId}
Delete Auth Callout Config
deleteAuthCallout 1 param → 204400401403404
GET
/core/beta/auth-callout/{authCalloutId}
Auth Callout Config
getAuthCallout 1 param → 200400401403404
GET
/core/beta/auth-callout/{authCalloutId}/target-accounts
Get Target Account List
listAuthCalloutTargetAccounts 1 param → 200400401403404
POST
/core/beta/auth-callout/{authCalloutId}/target-accounts
Configure Target Account
addAuthCalloutTargetAccount 1 param body → 204400401403404
DELETE
/core/beta/auth-callout/{authCalloutId}/target-accounts/{targetAccountId}
Delete Target Account
deleteAuthCalloutTargetAccount 2 params → 204400401403404
GET
/core/beta/auth-callout/{authCalloutId}/users
Get Target Account List
listAuthCalloutUsers 1 param → 200400401403404
POST
/core/beta/auth-callout/{authCalloutId}/users
Create Auth Callout User
addAuthCalloutUser 1 param body → 204400401403404
DELETE
/core/beta/auth-callout/{authCalloutId}/users/{acUserId}
Delete Control Account User
deleteAuthCalloutUser 2 params → 204400401403404
authz 3
POST
/core/beta/authz/check
Check Authz Decisions
check body → 200400401403404
GET
/core/beta/authz/policies
Get Policy List
listPolicies → 200400401403404
GET
/core/beta/authz/roles
Get Authz roles List
listRoles → 200400401403404
component-versions 2
GET
/core/beta/component-versions
Get Available Component Versions
getAvailableComponentVersions → 200400401403404
POST
/core/beta/component-versions
Get Available Component Versions By Type
getAvailableComponentVersionsByType body → 200400401403404
pull-consumer 3
DELETE
/core/beta/consumers/pull/{consumerId}
Delete Pull Consumer
deletePullConsumer 1 param → 204400401403404
GET
/core/beta/consumers/pull/{consumerId}
Get Pull Consumer
getPullConsumerInfo 1 param → 200400401403404
PATCH
/core/beta/consumers/pull/{consumerId}
Update Pull Consumer
updatePullConsumer 1 param body → 200400401403404
push-consumer 3
DELETE
/core/beta/consumers/push/{consumerId}
Delete Push Consumer
deletePushConsumer 1 param → 204400401403404
GET
/core/beta/consumers/push/{consumerId}
Get Push Consumer
getPushConsumerInfo 1 param → 200400401403404
PATCH
/core/beta/consumers/push/{consumerId}
Update Push Consumer
updatePushConsumer 1 param body → 200400401403404
kv-bucket 7
DELETE
/core/beta/jetstream/kv-bucket/{streamId}
Delete KV Bucket
deleteKvBucket 1 param → 204400401403404
GET
/core/beta/jetstream/kv-bucket/{streamId}
Get KV Bucket
getKvBucket 1 param → 200400401403404
PATCH
/core/beta/jetstream/kv-bucket/{streamId}
Update KV Bucket
updateKvBucket 1 param body → 200400401403404
GET
/core/beta/jetstream/kv-bucket/{streamId}/consumers
List Consumers
listKvConsumers 1 param → 200400401403404
POST
/core/beta/jetstream/kv-bucket/{streamId}/consumers/pull
Create Pull Consumer
createKvPullConsumer 1 param body → 201400401403404
POST
/core/beta/jetstream/kv-bucket/{streamId}/consumers/push
Create Push Consumer
createKvPushConsumer 1 param body → 201400401403404
DELETE
/core/beta/jetstream/kv-bucket/{streamId}/purge
Purge KV Bucket
purgeKvBucket 1 param → 204400401403404
mirror 7
DELETE
/core/beta/jetstream/mirror/{streamId}
Delete Mirror
deleteMirror 1 param → 204400401403404
GET
/core/beta/jetstream/mirror/{streamId}
Get Mirror
getMirror 1 param → 200400401403404
PATCH
/core/beta/jetstream/mirror/{streamId}
Update Mirror
updateMirror 1 param body → 200400401403404
GET
/core/beta/jetstream/mirror/{streamId}/consumers
List Consumers
listMirrorConsumers 1 param → 200400401403404
POST
/core/beta/jetstream/mirror/{streamId}/consumers/pull
Create Pull Consumer
createMirrorPullConsumer 1 param body → 201400401403404
POST
/core/beta/jetstream/mirror/{streamId}/consumers/push
Create Push consumer
createMirrorPushConsumer 1 param body → 201400401403404
DELETE
/core/beta/jetstream/mirror/{streamId}/purge
Purge Mirror
purgeMirror 1 param → 204400401403404
object-bucket 7
DELETE
/core/beta/jetstream/object-bucket/{streamId}
Delete Object Bucket
deleteObjectBucket 1 param → 204400401403404
GET
/core/beta/jetstream/object-bucket/{streamId}
Get Object Bucket
getObjectBucket 1 param → 200400401403404
PATCH
/core/beta/jetstream/object-bucket/{streamId}
Update Object Bucket
updateObjectBucket 1 param body → 200400401403404
GET
/core/beta/jetstream/object-bucket/{streamId}/consumers
List Consumers
listObjConsumers 1 param → 200400401403404
POST
/core/beta/jetstream/object-bucket/{streamId}/consumers/pull
Create Pull Consumer
createObjPullConsumer 1 param body → 201400401403404
POST
/core/beta/jetstream/object-bucket/{streamId}/consumers/push
Create Push Consumer
createObjPushConsumer 1 param body → 201400401403404
DELETE
/core/beta/jetstream/object-bucket/{streamId}/purge
Purge Object Bucket
purgeObjBucket 1 param → 204400401403404
stream 7
DELETE
/core/beta/jetstream/stream/{streamId}
Delete Stream
deleteStream 1 param → 204400401403404
GET
/core/beta/jetstream/stream/{streamId}
Get Stream
getStreamInfo 1 param → 200400401403404
PATCH
/core/beta/jetstream/stream/{streamId}
Update Stream
updateStream 1 param body → 200400401403404
GET
/core/beta/jetstream/stream/{streamId}/consumers
List Consumers
listConsumers 1 param → 200400401403404
POST
/core/beta/jetstream/stream/{streamId}/consumers/pull
Create Pull Consumer
createPullConsumer 1 param body → 201400401403404
POST
/core/beta/jetstream/stream/{streamId}/consumers/push
Create Push Consumer
createPushConsumer 1 param body → 201400401403404
DELETE
/core/beta/jetstream/stream/{streamId}/purge
Purge Stream
purgeStream 1 param → 204400401403404
license 3
DELETE
/core/beta/license
Delete License
deleteLicense → 200400401403404
GET
/core/beta/license
Get License Status
getLicenseStatus → 200400401403404
PUT
/core/beta/license
Update License
updateLicense body → 200400401403404
issuance 1
GET
/core/beta/nats-user-issuances/{issuanceId}
Get nats user issuance
getNatsUserIssuance 1 param → 200400401403404
nats-user 13
DELETE
/core/beta/nats-users/{userId}
Delete NATS User
deleteNatsUser 1 param → 204400401403404
GET
/core/beta/nats-users/{userId}
Get NATS User
getNatsUser 1 param → 200400401403404
PATCH
/core/beta/nats-users/{userId}
Update NATS User
updateNatsUser 1 param body → 200400401403404
GET
/core/beta/nats-users/{userId}/app-users
List Team App Users
listNatsUserTeamAppUsers 1 param → 200400401403404
DELETE
/core/beta/nats-users/{userId}/app-users/{teamAppUserId}
Unassign Team App User from NATS User
unAssignNatsUserTeamAppUser 2 params → 204400401403404
POST
/core/beta/nats-users/{userId}/app-users/{teamAppUserId}
Assign Team App User to NATS User
assignNatsUserTeamAppUser 2 params body → 201400401403404
POST
/core/beta/nats-users/{userId}/bearer-jwt
Get Bearer JWT
downloadNatsUserBearerJwt 1 param → 200400401403404
GET
/core/beta/nats-users/{userId}/connections
List NATs User Connections
listNatsUserConnections 6 params → 200400401403404
POST
/core/beta/nats-users/{userId}/copy
Copy nats user
copyNatsUser 1 param body → 200400401403404
POST
/core/beta/nats-users/{userId}/creds
Get Creds
downloadNatsUserCreds 1 param → 200400401403404
POST
/core/beta/nats-users/{userId}/http-gw-token
Get HTTP Gateway Token
downloadNatsUserHttpGwToken 1 param → 201400401403404
GET
/core/beta/nats-users/{userId}/issuances
List nats user issuances
listNatsUserIssuances 1 param → 200400401403404
POST
/core/beta/nats-users/{userId}/rotate
Rotate nats user nkey and seed
rotateNatsUser 1 param → 200400401403404
oidc-provider 6
GET
/core/beta/oidc-providers
List OIDC Providers
listOidcProviders → 200400401403404
POST
/core/beta/oidc-providers
Create OIDC Provider
createOidcProvider body → 201400401403404
DELETE
/core/beta/oidc-providers/{oidcProviderId}
Delete OIDC Provider
deleteOidcProvider 1 param → 204400401403404
GET
/core/beta/oidc-providers/{oidcProviderId}
Get OIDC Provider
getOidcProvider 1 param → 200400401403404
PATCH
/core/beta/oidc-providers/{oidcProviderId}
Update OIDC Provider
updateOidcProvider 1 param body → 200400401403404
GET
/core/beta/oidc-providers/defaults
List OIDC Provider Defaults
listOidcDefaultProvider → 200400401403404
personal-access-token 3
DELETE
/core/beta/personal-access-tokens/{tokenId}
Delete Personal Access Token
deletePersonalAccessToken 1 param → 204400401403404
GET
/core/beta/personal-access-tokens/{tokenId}
Get Personal Access Token
getPersonalAccessToken 1 param → 200400401403404
PATCH
/core/beta/personal-access-tokens/{tokenId}
Update Personal Access Token
updatePersonalAccessToken 1 param body → 200400401403404
platform-components 1
POST
/core/beta/platform-components/connect
Connect a Platform Component
platformComponentConnect 1 param body → 200400401403404
app-service-account-tokens 3
DELETE
/core/beta/service-account-tokens/app/{tokenId}
Delete App Service Account Token
deleteAppServiceAccountToken 1 param → 204400401403404
GET
/core/beta/service-account-tokens/app/{tokenId}
Get App Service Account Token
getAppServiceAccountToken 1 param → 200400401403404
PATCH
/core/beta/service-account-tokens/app/{tokenId}
Update App Service Account Token
updateAppServiceAccountToken 1 param body → 200400401403404
team-service-account-tokens 3
DELETE
/core/beta/service-account-tokens/team/{tokenId}
Delete Team Service Account Token
deleteTeamServiceAccountToken 1 param → 204400401403404
GET
/core/beta/service-account-tokens/team/{tokenId}
Get Team Service Account Token
getTeamServiceAccountToken 1 param → 200400401403404
PATCH
/core/beta/service-account-tokens/team/{tokenId}
Update Team Service Account Token
updateTeamServiceAccountToken 1 param body → 200400401403404
app-service-account 5
DELETE
/core/beta/service-accounts/app/{serviceAccountId}
Delete App Service Account
deleteAppServiceAccount 1 param → 204400401403404
GET
/core/beta/service-accounts/app/{serviceAccountId}
Get App Service Account
getAppServiceAccount 1 param → 200400401403404
PATCH
/core/beta/service-accounts/app/{serviceAccountId}
Update App Service Account
updateAppServiceAccount 1 param body → 200400401403404
GET
/core/beta/service-accounts/app/{serviceAccountId}/tokens
List Access Tokens for App Service Account
listAppServiceAccountTokens 1 param → 200400401403404
POST
/core/beta/service-accounts/app/{serviceAccountId}/tokens
Create Acess Token for App Service Account
createAppServiceAccountToken 1 param body → 200400401403404
team-service-account 5
DELETE
/core/beta/service-accounts/team/{serviceAccountId}
Delete Team Service Account
deleteTeamServiceAccount 1 param → 204400401403404
GET
/core/beta/service-accounts/team/{serviceAccountId}
Get Team Service Account
getTeamServiceAccount 1 param → 200400401403404
PATCH
/core/beta/service-accounts/team/{serviceAccountId}
Update Team Service Account
updateTeamServiceAccount 1 param body → 200400401403404
GET
/core/beta/service-accounts/team/{serviceAccountId}/tokens
List Access Tokens for Team Service Account
listTeamServiceAccountTokens 1 param → 200400401403404
POST
/core/beta/service-accounts/team/{serviceAccountId}/tokens
Create Acess Token for Team Service Account
createTeamServiceAccountToken 1 param body → 200400401403404
stream-export 5
DELETE
/core/beta/stream-exports/{streamExportId}
Delete Stream Export
deleteStreamExport 1 param → 204400401403404
GET
/core/beta/stream-exports/{streamExportId}
Get Stream Export
getStreamExport 1 param → 200400401403404
GET
/core/beta/stream-exports/{streamExportId}/shares
List Stream Shares
listStreamShares 1 param → 200400401403404
POST
/core/beta/stream-exports/{streamExportId}/shares
Create Stream Shares
createStreamShares 1 param body → 201400401403404
DELETE
/core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic}
Delete Stream Share
deleteStreamShare 2 params → 204400401403404
stream-import 2
DELETE
/core/beta/stream-imports/{streamImportId}
Delete Stream Import
deleteStreamImport 1 param → 204400401403404
GET
/core/beta/stream-imports/{streamImportId}
Get Stream Import
getStreamImport 1 param → 200400401403404
subject-export 6
DELETE
/core/beta/subject-exports/{subjectExportId}
Delete Subject Export
deleteSubjectExport 1 param → 204400401403404
GET
/core/beta/subject-exports/{subjectExportId}
Get Subject Export
getSubjectExport 1 param → 200400401403404
PATCH
/core/beta/subject-exports/{subjectExportId}
Update Subject Export
updateSubjectExport 1 param body → 200400401403404
GET
/core/beta/subject-exports/{subjectExportId}/shares
List Subject Shares
listSubjectShares 1 param → 200400401403404
POST
/core/beta/subject-exports/{subjectExportId}/shares
Create Subject Shares
createSubjectShares 1 param body → 201400401403404
DELETE
/core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic}
Delete Subject Share
deleteSubjectShare 2 params → 204400401403404
subject-import 3
DELETE
/core/beta/subject-imports/{subjectImportId}
Delete Subject Import
deleteSubjectImport 1 param → 204400401403404
GET
/core/beta/subject-imports/{subjectImportId}
Get Subject Import
getSubjectImport 1 param → 200400401403404
PATCH
/core/beta/subject-imports/{subjectImportId}
Update Subject Import
updateSubjectImport 1 param body → 200400401403404
system 44
DELETE
/core/beta/systems/{systemId}
Delete System
deleteSystem 1 param → 204400401403404
GET
/core/beta/systems/{systemId}
Get System
getSystem 1 param → 200400401403404
PATCH
/core/beta/systems/{systemId}
Update System
updateSystem 2 params body → 200400401403404
GET
/core/beta/systems/{systemId}/accounts
List Accounts
listAccounts 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/accounts
Create Account
createAccount 1 param body → 201400401403404
GET
/core/beta/systems/{systemId}/accounts-overview-metrics
List Accounts overview metrics
listAccountsOverviewMetrics 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/agent-tokens
List Agent Tokens
listAgentTokens 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/agent-tokens
Rotate Agent Token
rotateAgentToken 1 param body → 201400401403404
GET
/core/beta/systems/{systemId}/agent-tokens/current
Get Current Agent Token
getCurrentAgentToken 1 param → 201400401403404
GET
/core/beta/systems/{systemId}/alert-rules
List System Alert Rules
listSystemAlertRules 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/alert-rules
Create System Alert Rule
createSystemAlertRule 1 param body → 200400401403404
DELETE
/core/beta/systems/{systemId}/alert-rules/{alertRuleId}
Delete System Alert Rule
deleteSystemAlertRule 2 params → 204400401403404
GET
/core/beta/systems/{systemId}/alert-rules/{alertRuleId}
Get System Alert Rule
getSystemAlertRule 2 params → 200400401403404
PATCH
/core/beta/systems/{systemId}/alert-rules/{alertRuleId}
Update System Alert Rules
updateSystemAlertRule 2 params body → 200400401403404
GET
/core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run
Run System Alert Rule
runSystemAlertRule 2 params → 200400401403404
GET
/core/beta/systems/{systemId}/app-users
List System Team App Users
listSystemTeamAppUsers 1 param → 200400401403404
DELETE
/core/beta/systems/{systemId}/app-users/{teamAppUserId}
Unassign Team App User from System
unAssignSystemTeamAppUser 2 params → 204400401403404
POST
/core/beta/systems/{systemId}/app-users/{teamAppUserId}
Assign Team App User to System
assignSystemTeamAppUser 2 params body → 201400401403404
GET
/core/beta/systems/{systemId}/audit/jobs
List Audit Jobs
listSystemAuditJobs 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/audit/jobs/{jobId}
Get Audit Job Status
getSystemAuditJobStatus 2 params → 200400401403404
GET
/core/beta/systems/{systemId}/audit/jobs/{jobId}/result
Get Audit Job Result
getSystemAuditJobResult 2 params → 200400401403404
POST
/core/beta/systems/{systemId}/audit/run
Run System Audit Check
runSystemAuditCheck 1 param body → 202400401403404
GET
/core/beta/systems/{systemId}/auth-callout
List Auth Callout Configs
listAuthCalloutConfigs 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/auth-callout
Enable Auth Callout For System
enableAuthCallout 1 param body → 204400401403404
GET
/core/beta/systems/{systemId}/auth-callout/authenticators
Get List of Available Authenticators
listAuthCalloutAuthenticators 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/bulk/shares
Share assets across accounts
bulkShare 1 param body → 204400401403404
GET
/core/beta/systems/{systemId}/connections
List Connections
listConnections 8 params → 200400401403404
GET
/core/beta/systems/{systemId}/export
Export System Seeds
getSystemExport 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/health/check
Get System Health Check
getSystemHealthCheck 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/health/clusters
Get Cluster Overview
getSystemHealthClusters 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/health/jetstream
Get JetStream Health Report
getSystemHealthJetstream 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/health/servers
Get System Server List
getSystemHealthServers 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/import-account
Import Account
importAccount 1 param body → 204400401403404
POST
/core/beta/systems/{systemId}/import-user
Import User
importUser 1 param body → 201400401403404
GET
/core/beta/systems/{systemId}/info/accounts
List System Accounts Info
listSystemInfoAccounts 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/info/servers
List System Servers info
listSystemInfoServers 1 param → 200400401403404
POST
/core/beta/systems/{systemId}/jwt-sync
Re-sync JWTs of all accounts in this system
systemJWTSync 1 param → 204400401403404
GET
/core/beta/systems/{systemId}/limits
Get System Limits
getSystemLimits 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/nats-clusters
List Clusters
listClusters 1 param → 200400401403404
PATCH
/core/beta/systems/{systemId}/platform-components
Update Platform Components for System
updatePlatformComponents 1 param body → 204400401403404
GET
/core/beta/systems/{systemId}/platform-components/{id}/tokens
Get a component access token
getComponentToken 2 params → 200400401403404
GET
/core/beta/systems/{systemId}/prometheus-metrics
Get Prometheus Metrics
getSystemPrometheusMetrics 1 param → 200400401403404
GET
/core/beta/systems/{systemId}/servers
List Servers
listServers 1 param → 200400401403404
DELETE
/core/beta/systems/{systemId}/unmanage
Unmanage System
unmanageSystem 1 param → 204400401403404
team 15
DELETE
/core/beta/teams/{teamId}
Delete Team
deleteTeam 1 param → 204400401403404
GET
/core/beta/teams/{teamId}
Get Team
getTeam 1 param → 200400401403404
PATCH
/core/beta/teams/{teamId}
Update Team
updateTeam 1 param body → 200400401403404
GET
/core/beta/teams/{teamId}/app-users
List App Users
listTeamAppUsers 1 param → 200400401403404
DELETE
/core/beta/teams/{teamId}/app-users/{appUserId}
Unassign App User from Team
unAssignTeamAppUser 2 params → 204400401403404
PATCH
/core/beta/teams/{teamId}/app-users/{appUserId}
Update App User Team Assignment
updateTeamAppUser 2 params body → 200400401403404
POST
/core/beta/teams/{teamId}/app-users/invitations
Invite App Users
inviteAppUser 1 param body → 200400401403404
POST
/core/beta/teams/{teamId}/app-users/leave
Leave Team
leaveTeam 1 param → 204400401403404
POST
/core/beta/teams/{teamId}/import-system
Import a System
importSystem 1 param body → 201400401403404
GET
/core/beta/teams/{teamId}/info/app-users
List info of App Users in Team
listTeamInfoAppUsers 1 param → 200400401403404
GET
/core/beta/teams/{teamId}/service-accounts
List Team Service Accounts
listTeamServiceAccounts 1 param → 200400401403404
POST
/core/beta/teams/{teamId}/service-accounts
Create Team Service Account
createTeamServiceAccount 1 param body → 200400401403404
GET
/core/beta/teams/{teamId}/systems
List Systems
listTeamSystems 1 param → 200400401403404
POST
/core/beta/teams/{teamId}/systems
Create System
createSystem 1 param body → 200400401403404
GET
/core/beta/teams/{teamId}/team-limits
Get Team Limits
getTeamLimits 1 param → 200400401403404
workloads 2
GET
/workloads/alpha/{accountId}/limits
Get Workloads limits
getWorkloadLimits 1 param → 200400401403404
GET
/workloads/alpha/{accountId}/tags
List Workload tags
listWorkloadTags 1 param → 200400401403404

Schemas 487

The contract defines 487 schemas that model the data the API accepts and returns. The most detailed are InsightsStream (38 properties), JSCommonStreamConfig (36 properties), ConsumerConfig (34 properties), ConnInfo (33 properties). Each schema is shown below with its type and property counts.

AcceptTermsResponse
object
2 properties 2 required
Account
object
Account holds account specific claims data
8 properties
AccountAssignment
object
3 properties 2 required
AccountAuthType
string
AccountChartType
string
AccountClaims
object
AccountClaims defines the body of an account JWT
1 property
AccountClaimsInfo
object
1 property 1 required
AccountConnectionsListResponse
object
1 property 1 required
AccountCreateRequest
object
10 properties 1 required
AccountExportResponse
object
6 properties 1 required
AccountInfo
object
10 properties 7 required
AccountInfoListResponse
object
1 property 1 required
AccountJWTSettings
object
5 properties
AccountJWTSettingsPatch
object
7 properties
AccountLimits
object
6 properties
AccountListResponse
object
1 property 1 required
AccountMetrics
object
14 properties 14 required
AccountOverviewResponse
object
2 properties 2 required
AccountUpdateRequest
object
10 properties
AccountViewResponse
object
24 properties 15 required
AccountsOverviewListResponse
object
1 property 1 required
AckPolicy
string
enums have been changed to match UnmarshalJSON in https://github.com/nats-io/jsm.go/blob/main/api/consumers.go
Activation
object
Activation defines the custom parts of an activation claim
3 properties
ActivationClaims
object
ActivationClaims holds the data specific to an activation JWT
1 property
AddRequest
object
6 properties 2 required
AddResponse
object
2 properties 2 required
AdminAppUserCreateRequest
object
3 properties 2 required
AdminAppUserCreateResponse
object
1 property
AgentTokenCurrentResponse
object
2 properties
AgentTokenListResponse
object
1 property 1 required
AgentTokenRotateRequest
object
AgentTokenRotateResponse
object
2 properties 2 required
AgentTokenViewResponse
object
6 properties 4 required
AlertListResponse
object
1 property 1 required
AlertRuleAccountCreateRequest
object
3 properties
AlertRuleBaseCreateRequest
object
8 properties 5 required
AlertRuleListResponse
object
1 property 1 required
AlertRuleOperator
string
AlertRuleSeverity
string
AlertRuleSystemCreateRequest
AlertRuleThresholdMetric
string
AlertRuleType
string
AlertRuleUpdateRequest
object
8 properties
AlertRuleViewResponse
object
16 properties 9 required
AlertStatus
string
AlertViewResponse
object
21 properties 12 required
ApexCoordinate
object
2 properties 2 required
ApexSeries
object
2 properties 2 required
AppPolicy
object
4 properties 3 required
AppPolicyGroup
string
AppPolicyStatement
object
6 properties 4 required
AppRole
object
7 properties 7 required
AppRoleEffect
string
AppRoleScope
string
AppUserAccessTokenCreateRequest
object
3 properties 1 required
AppUserAccessTokenCreateResponse
object
1 property
AppUserAccessTokenListResponse
object
1 property 1 required
AppUserAccessTokenUpdateRequest
object
3 properties
AppUserAccessTokenViewResponse
object
5 properties 3 required
AppUserAssignListResponse
object
1 property 1 required
AppUserAssignRequest
object
1 property 1 required
AppUserAssignResponse
object
11 properties 7 required
AppUserCreateRequest
object
3 properties 3 required
AppUserCreateResponse
object
1 property
AppUserInfo
object
4 properties 3 required
AppUserInfoListResponse
object
1 property 1 required
AppUserInvitationRequest
object
4 properties 3 required
AppUserInvitationResponse
object
2 properties 2 required
AppUserListResponse
object
1 property 1 required
AppUserType
string
AppUserUpdateRequest
object
3 properties
AppUserUpdateResponse
object
1 property
AppUserViewResponse
object
9 properties 7 required
ArtifactListResponse
object
1 property 1 required
ArtifactSummary
object
8 properties 7 required
ArtifactVersion
object
4 properties 1 required
AuditCheckResult
object
6 properties 5 required
AuditHealthResponse
object
6 properties 5 required
AuditJobListResponse
object
1 property 1 required
AuditJobRequest
object
4 properties 4 required
AuditJobResponse
object
6 properties 5 required
AuditSummary
object
7 properties 7 required
AuthCalloutAddTargetAccountRequest
object
3 properties 3 required
AuthCalloutAddUserRequest
object
1 property 1 required
AuthCalloutAuthenticatorComponentConfig
object
2 properties 2 required
AuthCalloutAuthenticatorConfigViewResponse
object
4 properties 4 required
AuthCalloutAuthenticatorUpdateRequest
object
3 properties 3 required
AuthCalloutAuthenticatorViewResponse
object
3 properties 2 required
AuthCalloutAuthenticatorsListResponse
object
1 property 1 required
AuthCalloutComponentConnectConfig
object
2 properties 2 required
AuthCalloutConfig
object
4 properties 3 required
AuthCalloutConfigListResponse
object
1 property 1 required
AuthCalloutEnableRequest
object
1 property 1 required
AuthCalloutTargetAccountListResponse
object
1 property 1 required
AuthCalloutTargetAccountViewResponse
object
7 properties 7 required
AuthCalloutUserViewResponse
object
3 properties 3 required
AuthCalloutUsersListResponse
object
1 property 1 required
AuthCalloutViewResponse
object
3 properties
AuthzRequest
object
2 properties 2 required
AuthzResponse
object
3 properties 3 required
AuthzViewRequest
array
AuthzViewResponse
array
AvailableChartVersion
object
5 properties 5 required
AvailableChartVersions
array
AvailableComponentVersionsRequest
object
3 properties 2 required
AvailableComponentVersionsResponse
object
BulkShareRequest
object
3 properties 3 required
BulkShareTarget
object
3 properties 3 required
BulkShareType
string
CatalogPlatformComponentConfig
object
2 properties 2 required
ChecksSummary
object
5 properties 4 required
ClaimType
string
ClaimType is used to indicate the type of JWT being stored in a Claim
ClaimsData
object
ClaimsData is the base struct for all claims
8 properties
ClusterChartType
string
ClusterInfo
object
ClusterInfo shows information about the underlying set of servers that make up the stream or consumer.
7 properties
ClusterOverview
object
11 properties 10 required
ClusterOverviewResponse
object
Cluster Overview Response
6 properties 4 required
ClusterOverviewSummary
object
5 properties 5 required
Collection
object
3 properties 3 required
Compression
string
ConnInfo
object
ConnInfo has detailed information on a per connection basis.
33 properties 13 required
ConnectorCreateRequest
object
4 properties
ConnectorsPlatformComponentConfig
object
1 property 1 required
Connz
object
Connz represents detailed information on current client connections.
7 properties 7 required
ConsumerConfig
object
ConsumerConfig is the configuration for a JetStream consumes NATS Schema Type io.nats.jetstream.api.v1.consumerconfiguration
34 properties 4 required
ConsumerInfo
object
ConsumerInfo reports the current state of a consumer
16 properties 11 required
DataLimits
object
10 properties 10 required
DataStats
object
DataStats reports how may msg and bytes. Applicable for both sent and received.
2 properties 2 required
DeliverPolicy
string
DiscardPolicy
string
enums have been changed to match UnmarshalJSON in https://github.com/nats-io/jsm.go/blob/main/api/streams.go
EntitlementsView
object
8 properties 8 required
Export
object
Export represents a single export
10 properties
ExportPatch
object
12 properties
ExportType
string
ExportType defines the type of import/export.
Exports
array
Exports is a slice of exports
ExternalAuthorization
object
3 properties 1 required
ExternalAuthorizationPatch
object
3 properties
ExternalStream
object
ExternalStream allows you to qualify access to a stream source in another account.
2 properties 2 required
GatewayConnection
object
3 properties 3 required
GatewayStat
object
GatewayStat holds gateway statistics.
5 properties 5 required
GenericFields
object
3 properties
GetResponse
object
1 property
GroupMapping
object
2 properties
HealthCheckResponse
object
Health Check Response - equivalent to 'nats server report health'
6 properties 5 required
HealthError
object
2 properties 2 required
HealthSummary
object
5 properties 5 required
HttpGatewayPlatformComponentConfig
object
3 properties 3 required
Import
object
Import describes a mapping from another account into this one
8 properties
ImportPatch
object
8 properties
Imports
array
Imports is a list of import structs
Info
object
2 properties
InsightsAccountStats
object
24 properties 24 required
InsightsConn
object
32 properties 32 required
InsightsConsumer
object
31 properties 31 required
InsightsLeaf
object
17 properties 17 required
InsightsPlatformComponentConfig
object
1 property 1 required
InsightsServer
object
18 properties 18 required
InsightsStream
object
38 properties 38 required
InsightsSub
object
8 properties 8 required
InvitationDecisionRequest
object
1 property 1 required
InvitationListResponse
object
1 property 1 required
JSAcctStats
JSApiError
object
JSApiError retains the existing schema name; the upstream Go type is now ApiError.
3 properties 1 required
JSCommonConsumerConfigRequest
object
20 properties 4 required
JSCommonStreamConfig
object
36 properties 15 required
JSCommonStreamInfo
object
8 properties 4 required
JSConsumerInfoListResponse
object
1 property 1 required
JSConsumerInfoResponse
object
2 properties
JSConsumerType
string
JSKVBucketConfig
object
15 properties 2 required
JSKVBucketListResponse
object
1 property 1 required
JSKVBucketUpdateRequest
object
1 property 1 required
JSKVBucketViewResponse
object
5 properties 5 required
JSMirrorConfigRequest
object
2 properties
JSMirrorConfigResponse
JSMirrorInfoListResponse
object
1 property 1 required
JSMirrorInfoResponse
object
4 properties
JSObjectBucketConfig
object
1 property
JSObjectBucketListResponse
object
1 property 1 required
JSObjectBucketUpdateRequest
object
3 properties 1 required
JSObjectBucketViewResponse
object
4 properties 4 required
JSPersistMode
string
JSPlacementOptionsResponse
object
3 properties 3 required
JSPullConsumerConfigRequest
object
7 properties
JSPullConsumerInfoResponse
object
16 properties 11 required
JSPullConsumerUpdateRequest
object
16 properties
JSPushConsumerConfigRequest
object
6 properties
JSPushConsumerInfoResponse
object
15 properties 10 required
JSPushConsumerUpdateRequest
object
13 properties
JSShareRequest
object
JSStreamConfigRequest
object
1 property
JSStreamConfigResponse
JSStreamConsumerLimits
object
2 properties
JSStreamInfoListResponse
object
1 property 1 required
JSStreamInfoResponse
object
3 properties
JSType
string
JetStreamAPIStats
object
4 properties 3 required
JetStreamAccountLimits
object
8 properties 8 required
JetStreamAccountStats
object
JetStreamAccountStats returns current statistics about the account's JetStream usage.
4 properties 2 required
JetStreamConfig
object
JetStreamConfig determines this server's configuration. MaxMemory and MaxStore are in bytes.
5 properties 2 required
JetStreamLimits
object
8 properties
JetStreamReportResponse
object
JetStream Report Response - equivalent to 'nats server report jetstream'
6 properties 4 required
JetStreamServerInfo
object
13 properties 11 required
JetStreamStats
object
Statistics about JetStream for this server.
7 properties 7 required
JetStreamSummary
object
7 properties 7 required
JetStreamTier
object
7 properties 7 required
JetStreamTieredLimits
object
JetStreamTieredLimitsPatch
object
JetStreamVarz
object
JetStreamVarz contains basic runtime information about jetstream
3 properties
JwtSyncStatus
string
LeafInfo
object
LeafInfo has detailed information on each remote leafnode connection.
12 properties 9 required
Leafz
object
Leafz represents detailed information on Leafnodes.
4 properties 4 required
LicenseStatusResponse
object
7 properties 1 required
LicenseUpdateRequest
object
1 property 1 required
ListResponse
object
1 property 1 required
LostStreamData
object
LostStreamData indicates msgs that have been lost during file checks and recover due to corruption
2 properties 2 required
Mapping
object
MappingPatch
object
MetaClusterInfo
object
MetaClusterInfo shows information about the meta group.
4 properties 1 required
NatsAlertingConfig
object
3 properties
NatsAlertingConfigPatch
object
3 properties
NatsCluster
object
6 properties 6 required
NatsClusterListResponse
object
1 property 1 required
NatsCreateUserJwtSettings
object
used to provide default values for create requests extention of jwt.UserPermissionsLimits
6 properties
NatsLimits
object
3 properties
NatsServer
object
1 property
NatsServerInfoListResponse
object
1 property 1 required
NatsServerListResponse
object
1 property 1 required
NatsUserConnectionsListResponse
object
1 property 1 required
NatsUserCopyRequest
object
2 properties 2 required
NatsUserCreateRequest
object
4 properties 2 required
NatsUserHTTPGWTokenCreateReply
object
1 property 1 required
NatsUserInfo
object
3 properties 3 required
NatsUserIssuanceEvent
object
6 properties 5 required
NatsUserIssuanceEventType
string
NatsUserIssuanceInfo
object
10 properties 9 required
NatsUserIssuanceStatus
string
NatsUserIssuanceStatus indicates status of an issuance relative to its signing key In context of issuance, status indicates following: Active - Signing key exi…
NatsUserIssuanceViewResponse
object
12 properties 11 required
NatsUserIssuancesListResponse
object
1 property 1 required
NatsUserJwtSettings
object
Set correct allowed values extention of jwt.UserPermissionsLimits
6 properties
NatsUserJwtSettingsPatch
object
12 properties
NatsUserListResponse
object
1 property 1 required
NatsUserRevocationRequest
object
1 property 1 required
NatsUserRevocationViewResponse
object
5 properties 4 required
NatsUserUpdateRequest
object
3 properties
NatsUserViewResponse
object
13 properties 12 required
Nexfile
object
7 properties 7 required
ObjectStoreConfig
object
ObjectStoreConfig is the config for the object store.
9 properties 1 required
OidcProviderAddRequest
object
18 properties 2 required
OidcProviderDefaultsListResponse
object
1 property 1 required
OidcProviderDefaultsResponse
object
3 properties 3 required
OidcProviderListResponse
object
1 property 1 required
OidcProviderUpdateRequest
object
17 properties
OidcProviderViewResponse
object
19 properties 4 required
Operator
object
Operator specific claims
6 properties
OperatorClaims
object
OperatorClaims define the data for an operator JWT
1 property
OperatorExport
object
5 properties 3 required
OperatorLimits
object
OperatorLimits are used to limit access by an account
1 property
OperatorLimitsPatch
object
18 properties
PeerInfo
object
PeerInfo shows information about all the peers in the cluster that are supporting the stream or consumer.
6 properties 4 required
Permission
object
Permission defines allow/deny subjects
2 properties
PermissionPatch
object
2 properties
Permissions
object
Permissions are used to restrict subject access, either on a user or for everyone on a server by default
3 properties
Placement
object
Placement describes stream placement requirements for a stream or leader.
2 properties
PlatformComponent
object
4 properties 3 required
PlatformComponentConfigs
object
PlatformComponentConnectConfig
object
PlatformComponentTokenViewResponse
object
4 properties 3 required
PlatformComponentType
string
PlatformComponentsConfigSchema
object
4 properties 3 required
PlatformComponentsConnectRequest
object
2 properties 1 required
PlatformComponentsConnectViewResponse
object
4 properties 3 required
PlatformComponentsUpdateRequest
object
3 properties 2 required
PlatformComponentsViewResponse
object
2 properties 2 required
PolicyListResponse
object
1 property 1 required
PriorityGroupState
object
PriorityGroupState is the state of a consumer priority group.
3 properties 1 required
PriorityPolicy
string
PriorityPolicy determines how messages are selected from priority groups.
PromSampleValue
object
2 properties 2 required
RaftMetaInfo
object
3 properties 3 required
RaftReplica
object
6 properties 6 required
RaftSummary
object
6 properties 6 required
RePublish
object
RePublish allows a source subject to be mapped to a destination subject for republishing.
3 properties 1 required
ReceiverConfig
RemoveRequest
object
4 properties
ReplayPolicy
string
ResponsePermission
object
ResponsePermission can be used to allow responses to any reply subject that is received on a valid subscription.
2 properties 2 required
ResponsePermissionPatch
object
2 properties
ResponseType
string
ResponseType is used to store an export response type
RetentionPolicy
string
RevocationList
object
RevocationList is used to store a mapping of public keys to unix timestamps
RevocationListPatch
object
RoleListResponse
object
1 property 1 required
RouteStat
object
RouteStat holds route statistics.
5 properties 4 required
SDKubeLimit
object
2 properties 2 required
SafeComponentConfig
object
1 property 1 required
SamplingRate
integer
Schema
object
10 properties 9 required
SchemaCompatPolicy
string
SchemaCompatPolicy represents the compatibility policy for schema evolution. Supported values are "none", "backwards", "forward", and "full".
SchemaFormat
string
SchemaFormat represents the format of a schema definition. Supported values are "jsonschema".
SchemaRegistryAddRequest
SchemaRegistryAddResponse
SchemaRegistryCompatPolicy
string
SchemaRegistryFormat
string
SchemaRegistryGetResponse
SchemaRegistryListResponse
SchemaRegistryPlatformComponentConfig
object
2 properties 2 required
SchemaRegistryRemoveRequest
SchemaRegistrySchema
SchemaRegistryUpdateRequest
SchemaRegistryUpdateResponse
SchemaRegistryValidateRequest
SchemaRegistryValidateResponse
ScraperComponentConfig
object
3 properties 3 required
SequenceInfo
object
SequenceInfo is the consumer and stream sequence that uniquely identify a message
3 properties 2 required
ServerHealthInfo
object
6 properties 4 required
ServerInfo
object
ServerInfo identifies remote servers.
10 properties 7 required
ServerListInfo
object
18 properties 15 required
ServerListResponse
object
Server List Response - equivalent to 'nats server ls'
6 properties 4 required
ServerStats
object
ServerStats hold various statistics that we will periodically send out.
15 properties 11 required
ServerStatsMsg
object
ServerStatsMsg is sent periodically with stats updates.
2 properties 2 required
ServerSummary
object
7 properties 7 required
ServiceAccountCreateRequest
object
3 properties 3 required
ServiceAccountListResponse
object
1 property 1 required
ServiceAccountResourceScope
string
ServiceAccountScope
string
ServiceAccountUpdateRequest
object
3 properties
ServiceAccountViewResponse
object
8 properties 7 required
ServiceLatency
object
ServiceLatency is used when observing and exported service for latency measurements. Sampling 1-100, represents sampling rate, defaults to 100. Results is the…
2 properties 2 required
ServiceLatencyPatch
object
2 properties
SigningKeyExport
object
2 properties 2 required
SigningKeyGroupCopyRequest
object
1 property 1 required
SigningKeyGroupCreateRequest
object
4 properties 2 required
SigningKeyGroupCreateResponse
object
1 property
SigningKeyGroupExport
object
2 properties 2 required
SigningKeyGroupListResponse
object
1 property 1 required
SigningKeyGroupUpdateRequest
object
3 properties
SigningKeyGroupViewResponse
object
9 properties 7 required
SigningKeyListResponse
object
1 property 1 required
SigningKeyRotateResponse
object
1 property
SigningKeyScope
object
4 properties 4 required
SigningKeyScopeType
string
SigningKeyUpdateRequest
object
2 properties
SigningKeyViewResponse
object
10 properties 8 required
SigningKeys
array
SigningKeys an array of either String or SigningKeyScope
SlackConfig
object
2 properties 2 required
SlackReceiverConfig
object
2 properties 2 required
SlowConsumerStats
object
4 properties 4 required
StartRequestSchema
object
2 properties 2 required
StorageType
string
StreamAlternate
object
3 properties 2 required
StreamConsumerSource
object
StreamConsumerSource configures the consumer used by a sourced stream.
2 properties 1 required
StreamExportCreateRequest
object
2 properties 2 required
StreamExportListResponse
object
1 property 1 required
StreamExportSharedListResponse
object
1 property 1 required
StreamExportSharedViewResponse
object
5 properties 5 required
StreamExportViewResponse
object
/ Stream export /
7 properties 7 required
StreamImportCreateRequest
object
5 properties 5 required
StreamImportListResponse
object
1 property 1 required
StreamImportViewResponse
object
/ Stream Import /
7 properties 7 required
StreamShareCreateRequest
object
/ Stream Share /
1 property 1 required
StreamShareListResponse
object
1 property 1 required
StreamShareViewResponse
object
1 property 1 required
StreamSource
object
StreamSource dictates how streams can source from other streams.
7 properties 1 required
StreamSourceInfo
object
StreamSourceInfo shows information about an upstream stream source.
7 properties 3 required
StreamState
object
12 properties 7 required
SubDetail
object
SubDetail is for verbose information for subscriptions.
7 properties 4 required
SubjectExportChartTypes
string
SubjectExportCreateRequest
object
3 properties 3 required
SubjectExportListResponse
object
1 property 1 required
SubjectExportSharedListResponse
object
1 property 1 required
SubjectExportSharedViewResponse
object
2 properties 2 required
SubjectExportUpdateRequest
object
3 properties
SubjectExportViewResponse
object
/ Subject Exports /
11 properties 11 required
SubjectImportCreateRequest
object
1 property 1 required
SubjectImportListResponse
object
1 property 1 required
SubjectImportUpdateRequest
object
1 property
SubjectImportViewResponse
object
/ Subject Imports /
6 properties 6 required
SubjectShareCreateRequest
object
1 property 1 required
SubjectShareListResponse
object
1 property 1 required
SubjectShareViewResponse
object
/ Subject Shares /
6 properties 6 required
SubjectTransformConfig
object
SubjectTransformConfig is for applying a subject transform (to matching messages) before doing anything else when a new message is received
2 properties 2 required
SystemAccountImportRequest
object
3 properties 2 required
SystemAssignment
object
4 properties 2 required
SystemConnectionType
string
SystemConnectionsListResponse
object
1 property 1 required
SystemCreateRequest
object
7 properties 2 required
SystemDirectConnectionOpts
object
6 properties 2 required
SystemDirectConnectionOptsPatch
object
6 properties
SystemExportResponse
object
4 properties 4 required
SystemImportRequest
object
11 properties
SystemInfo
object
13 properties 8 required
SystemLimitsResponse
object
3 properties 3 required
SystemListResponse
object
1 property 1 required
SystemLogForwardingOpts
object
5 properties 5 required
SystemLogForwardingOptsPatch
object
5 properties
SystemLogLevel
string
SystemManagedBy
string
SystemState
string
SystemUpdateRequest
object
9 properties
SystemUserImportRequest
object
3 properties
SystemViewResponse
object
26 properties 14 required
TLSMode
string
TLSPeerCert
object
TLSPeerCert contains basic information about a TLS peer certificate
3 properties
TeamAppUserAssociation
object
3 properties 3 required
TeamAppUserInfo
object
4 properties 4 required
TeamAppUserListResponse
object
1 property 1 required
TeamAppUserResourceType
string
TeamAppUserViewResponse
object
7 properties 7 required
TeamAssignment
object
4 properties 2 required
TeamCreateRequest
object
1 property 1 required
TeamInfo
object
2 properties 2 required
TeamLimits
object
4 properties 4 required
TeamLimitsResponse
object
3 properties 3 required
TeamListResponse
object
1 property 1 required
TeamUpdateRequest
object
1 property
TeamViewResponse
object
4 properties 3 required
TenantLimits
object
5 properties 4 required
TimeRange
object
TimeRange is used to represent a start and end time
2 properties
UpdatableKVBucketConfig
object
13 properties
UpdatableObjectBucketConfig
object
ObjectStoreConfig is the config for the object store.
7 properties
Update
object
4 properties 4 required
UpdateRequest
object
7 properties
UpdateResponse
object
2 properties 2 required
User
object
User defines the user specific data in a user JWT
1 property
UserClaims
object
UserClaims defines a user JWT
1 property
UserExport
object
4 properties 4 required
UserLimits
object
Src is a comma separated list of CIDR specifications
3 properties
UserPermissionLimits
object
2 properties
UserPermissionLimitsPatch
object
11 properties
ValidateRequest
object
2 properties 1 required
ValidateResponse
object
VersionResponse
object
3 properties 3 required
WeightedMapping
object
Mapping for publishes
3 properties 1 required
WorkloadAuctionRequest
object
2 properties 2 required
WorkloadAuctionResponse
object
4 properties 4 required
WorkloadField
object
8 properties 4 required
WorkloadFieldConstraint
object
5 properties
WorkloadFieldContstraintRange
object
4 properties
WorkloadFieldKind
string
WorkloadFieldType
string
WorkloadLifecycle
string
WorkloadLimits
object
2 properties 2 required
WorkloadLimitsResponse
object
2 properties 2 required
WorkloadStartRequest
object
6 properties 6 required
WorkloadStartResponse
object
2 properties 2 required
WorkloadState
string
WorkloadStateLimit
object
2 properties 2 required
WorkloadStateLimits
object
2 properties 2 required
WorkloadStopResponse
object
3 properties 3 required
WorkloadSummary
object
13 properties 10 required
WorkloadTagsResponse
object
1 property 1 required
WorkloadsListResponse
object
1 property 1 required
WorkloadsPlatformComponentConfig
object
2 properties 2 required
jwtAccountClaims
jwtUserClaims
AccountJWTSettingsPatch_authorization
object
AccountJWTSettingsPatch_limits
object
AccountOverviewResponse_metrics
object
8 properties 8 required
ClusterInfo_replicas_inner
object
ConnInfo_tls_peer_certs_inner
object
Connz_connections_inner
object
ConsumerInfo_cluster
object
ExportPatch_service_latency
object
GetResponse_schema
object
JetStreamTieredLimitsPatch_value
object
JetStreamVarz_config
object
JetStreamVarz_meta
object
JetStreamVarz_stats
object
Leafz_leafs_inner
object
NatsAlertingConfigPatch_receivers_inner_config
object
2 properties 2 required
NatsAlertingConfigPatch_receivers_inner
object
2 properties 2 required
NatsUserJwtSettingsPatch_pub
object
NatsUserJwtSettingsPatch_resp
object
NatsUserJwtSettingsPatch_times_inner
object
2 properties
ServerStats_gateways_inner
object
ServerStats_jetstream
object
ServerStats_routes_inner
object
ServiceAccountUpdateRequest_resources_value
object
SigningKeys_inner
StreamSource_consumer
object
StreamSource_external
object
StreamSourceInfo_error
object
StreamState_lost
object
SystemUpdateRequest_direct_connection_opts
object
SystemUpdateRequest_log_forwarding_opts
object
SystemUpdateRequest_nats_alerting_config
object
TeamLimits_num_sdkube
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synadia-communications-control-plane-openapi.yaml Raw ↑
#Management#Control Plane#JetStream#Account#NATS
← Back to S APIs
API Details
ID
synadia-communications:synadia-control-plane-synadia-cloud-api
Base URL
https://cloud.synadia.com/api
Docs
https://cloud.synadia.com/api-docs
Provider
Synadia Communications
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=synadia-communications-synadia-control-plane-synadia-cloud-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/synadia-communications-synadia-control-plane-synadia-cloud-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Synadia Control Plane / Synadia Cloud API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.