# Synadia Communications System API

**Canonical:** https://apis.io/apis/synadia-communications/synadia-communications-system-api/  
**Provider:** Synadia Communications — https://apis.io/providers/synadia-communications/  
**Base URL:** https://cloud.synadia.com/api  
**Documentation:** https://cloud.synadia.com/api-docs

Synadia Communications System API is one of 41 APIs that [Synadia Communications](https://apis.io/providers/synadia-communications/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

## Operations (44)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/core/beta/systems/{systemId}` | Delete System |
| GET | `/core/beta/systems/{systemId}` | Get System |
| PATCH | `/core/beta/systems/{systemId}` | Update System |
| GET | `/core/beta/systems/{systemId}/accounts` | List Accounts |
| POST | `/core/beta/systems/{systemId}/accounts` | Create Account |
| GET | `/core/beta/systems/{systemId}/accounts-overview-metrics` | List Accounts overview metrics |
| GET | `/core/beta/systems/{systemId}/agent-tokens` | List Agent Tokens |
| POST | `/core/beta/systems/{systemId}/agent-tokens` | Rotate Agent Token |
| GET | `/core/beta/systems/{systemId}/agent-tokens/current` | Get Current Agent Token |
| GET | `/core/beta/systems/{systemId}/alert-rules` | List System Alert Rules |
| POST | `/core/beta/systems/{systemId}/alert-rules` | Create System Alert Rule |
| DELETE | `/core/beta/systems/{systemId}/alert-rules/{alertRuleId}` | Delete System Alert Rule |
| GET | `/core/beta/systems/{systemId}/alert-rules/{alertRuleId}` | Get System Alert Rule |
| PATCH | `/core/beta/systems/{systemId}/alert-rules/{alertRuleId}` | Update System Alert Rules |
| GET | `/core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run` | Run System Alert Rule |
| GET | `/core/beta/systems/{systemId}/app-users` | List System Team App Users |
| DELETE | `/core/beta/systems/{systemId}/app-users/{teamAppUserId}` | Unassign Team App User from System |
| POST | `/core/beta/systems/{systemId}/app-users/{teamAppUserId}` | Assign Team App User to System |
| GET | `/core/beta/systems/{systemId}/audit/jobs` | List Audit Jobs |
| GET | `/core/beta/systems/{systemId}/audit/jobs/{jobId}` | Get Audit Job Status |
| GET | `/core/beta/systems/{systemId}/audit/jobs/{jobId}/result` | Get Audit Job Result |
| POST | `/core/beta/systems/{systemId}/audit/run` | Run System Audit Check |
| GET | `/core/beta/systems/{systemId}/auth-callout` | List Auth Callout Configs |
| POST | `/core/beta/systems/{systemId}/auth-callout` | Enable Auth Callout For System |
| GET | `/core/beta/systems/{systemId}/auth-callout/authenticators` | Get List of Available Authenticators |
| POST | `/core/beta/systems/{systemId}/bulk/shares` | Share assets across accounts |
| GET | `/core/beta/systems/{systemId}/connections` | List Connections |
| GET | `/core/beta/systems/{systemId}/export` | Export System Seeds |
| GET | `/core/beta/systems/{systemId}/health/check` | Get System Health Check |
| GET | `/core/beta/systems/{systemId}/health/clusters` | Get Cluster Overview |
| GET | `/core/beta/systems/{systemId}/health/jetstream` | Get JetStream Health Report |
| GET | `/core/beta/systems/{systemId}/health/servers` | Get System Server List |
| POST | `/core/beta/systems/{systemId}/import-account` | Import Account |
| POST | `/core/beta/systems/{systemId}/import-user` | Import User |
| GET | `/core/beta/systems/{systemId}/info/accounts` | List System Accounts Info |
| GET | `/core/beta/systems/{systemId}/info/servers` | List System Servers info |
| POST | `/core/beta/systems/{systemId}/jwt-sync` | Re-sync JWTs of all accounts in this system |
| GET | `/core/beta/systems/{systemId}/limits` | Get System Limits |
| GET | `/core/beta/systems/{systemId}/nats-clusters` | List Clusters |
| PATCH | `/core/beta/systems/{systemId}/platform-components` | Update Platform Components for System |
| GET | `/core/beta/systems/{systemId}/platform-components/{id}/tokens` | Get a component access token |
| GET | `/core/beta/systems/{systemId}/prometheus-metrics` | Get Prometheus Metrics |
| GET | `/core/beta/systems/{systemId}/servers` | List Servers |
| DELETE | `/core/beta/systems/{systemId}/unmanage` | Unmanage System |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-system-api-openapi.yml
- **Documentation** — https://docs.synadia.com/platform/control-plane
- **APIReference** — https://cloud.synadia.com/api-docs
- **SourceCode** — https://github.com/synadia-io/control-plane-sdk-go
- **Documentation** — https://docs.synadia.com/cloud/resources/http-gateway
- **APIReference** — https://api.ngs.global/api/

## Other Synadia Communications APIs (12)

- [Synadia Communications Account API](https://apis.io/apis/synadia-communications/synadia-communications-account-api/)
- [Synadia Communications Admin API](https://apis.io/apis/synadia-communications/synadia-communications-admin-api/)
- [Synadia Communications Agent Token API](https://apis.io/apis/synadia-communications/synadia-communications-agent-token-api/)
- [Synadia Communications Alert API](https://apis.io/apis/synadia-communications/synadia-communications-alert-api/)
- [Synadia Communications App Service Account API](https://apis.io/apis/synadia-communications/synadia-communications-app-service-account-api/)
- [Synadia Communications App Service Account Tokens API](https://apis.io/apis/synadia-communications/synadia-communications-app-service-account-tokens-api/)
- [Synadia Communications App User API](https://apis.io/apis/synadia-communications/synadia-communications-app-user-api/)
- [Synadia Communications Auth Callout API](https://apis.io/apis/synadia-communications/synadia-communications-auth-callout-api/)
- [Synadia Communications Authz API](https://apis.io/apis/synadia-communications/synadia-communications-authz-api/)
- [Synadia Communications Component Versions API](https://apis.io/apis/synadia-communications/synadia-communications-component-versions-api/)
- [Synadia Communications Extended KV Entry Operations API](https://apis.io/apis/synadia-communications/synadia-communications-extended-kv-entry-operations-api/)
- [Synadia Communications Issuance API](https://apis.io/apis/synadia-communications/synadia-communications-issuance-api/)

## Tags

System

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/synadia-communications/synadia-communications-system-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/synadia-communications/.