Synadia Communications

Synadia Communications Mirror API

The mirror API from Synadia Communications — 5 operation(s) for mirror.

GitHub OpenAPI

Operations 7

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/jetstream/mirror/{streamId} Delete a mirror stream · Delete Mirror #
Ask an LLM
“Can I delete a mirror without affecting its source stream?”
“What's the way to remove a mirror stream?”
Tell an agent destructive · confirm first
Delete mirror {streamId}.
Remove mirror stream {streamId}.
GET /core/beta/jetstream/mirror/{streamId} Get a mirror stream · Get Mirror #
Ask an LLM
“What source stream is my mirror copying from?”
“Can I see a mirror stream's configuration and state?”
Tell an agent
Show mirror {streamId}.
Get the details of mirror stream {streamId}.
PATCH /core/beta/jetstream/mirror/{streamId} Update a mirror stream's configuration · Update Mirror #
Ask an LLM
“Can I change a mirror's retention limits like max age or max bytes?”
“Is it possible to enable direct get or compression on an existing mirror?”
Tell an agent
Set mirror {streamId}'s max age to {max_age}.
Update mirror {streamId} to keep at most {max_msgs} messages and {max_bytes} bytes.
GET /core/beta/jetstream/mirror/{streamId}/consumers List consumers on a mirror · List Consumers #
Ask an LLM
“Which consumers are reading from my mirror stream?”
“Can I list consumers attached to a mirror?”
Tell an agent
List consumers on mirror {streamId}.
Show the consumers of mirror stream {streamId}.
POST /core/beta/jetstream/mirror/{streamId}/consumers/pull Create a pull consumer on a mirror · Create Pull Consumer #
Ask an LLM
“Can I fetch messages from a mirror stream with a pull consumer?”
“What policies are required for a mirror pull consumer?”
Tell an agent
Create pull consumer {durable_name} on mirror {streamId}: ack {ack_policy}, deliver {deliver_policy}, replay {replay_policy}, {num_replicas} replicas.
Add a durable pull consumer {durable_name} to mirror stream {streamId}.
POST /core/beta/jetstream/mirror/{streamId}/consumers/push Create a push consumer on a mirror · Create Push consumer #
Ask an LLM
“Can a mirror stream push its messages to a delivery subject?”
“Is flow control available on a mirror push consumer?”
Tell an agent
Create a push consumer on mirror {streamId} to {deliver_subject}: ack {ack_policy}, deliver {deliver_policy}, replay {replay_policy}, {num_replicas} replicas.
Push mirror {streamId}'s messages to {deliver_subject}.
DELETE /core/beta/jetstream/mirror/{streamId}/purge Purge all messages from a mirror · Purge Mirror #
Ask an LLM
“Can I empty a mirror stream's stored messages?”
“What's the way to purge a mirror without deleting it?”
Tell an agent destructive · confirm first
Purge mirror {streamId}.
Clear every message out of mirror stream {streamId}.

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

Other Resources

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/synadia-communications:synadia-communications-mirror-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-mirror-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Mirror 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 (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/openapi/synadia-communications-mirror-api-openapi.yml