Synadia Communications

Synadia Communications Subject Export API

The subject-export API from Synadia Communications — 3 operation(s) for subject-export.

GitHub OpenAPI

Operations 6

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/subject-exports/{subjectExportId} Delete a subject export · Delete Subject Export #
Ask an LLM
“Can I stop exporting a subject to other accounts?”
“What's the way to delete a subject export?”
Tell an agent destructive · confirm first
Delete subject export {subjectExportId}.
Remove subject export {subjectExportId}.
GET /core/beta/subject-exports/{subjectExportId} Get a subject export · Get Subject Export #
Ask an LLM
“What subject does a given export expose to other accounts?”
“Can I view a subject export's settings?”
Tell an agent
Show subject export {subjectExportId}.
Get info on subject export {subjectExportId}.
PATCH /core/beta/subject-exports/{subjectExportId} Update a subject export's settings · Update Subject Export #
Ask an LLM
“Can I turn on service latency metrics for an exported subject?”
“Is it possible to change the sampling percentage on export metrics?”
Tell an agent
Enable metrics on subject export {subjectExportId} with {metrics_sampling_percentage}% sampling.
Set metrics_enabled={metrics_enabled} on subject export {subjectExportId}.
GET /core/beta/subject-exports/{subjectExportId}/shares List accounts a subject export is shared with · List Subject Shares #
Ask an LLM
“Which accounts have been granted access to my exported subject?”
“Can I list the shares on a subject export?”
Tell an agent
List the shares for subject export {subjectExportId}.
Show which accounts subject export {subjectExportId} is shared with.
POST /core/beta/subject-exports/{subjectExportId}/shares Share a subject export with an account · Create Subject Shares #
Ask an LLM
“How do I share an exported subject with another account?”
“Do I need the target account's public NKey to share a subject?”
Tell an agent
Share subject export {subjectExportId} with account {target_account_nkey_public}.
Grant account {target_account_nkey_public} access to subject export {subjectExportId}.
DELETE /core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic} Revoke an account's share of a subject export · Delete Subject Share #
Ask an LLM
“Can I revoke one account's access to my exported subject?”
“What's the way to unshare a subject export from an account?”
Tell an agent destructive · confirm first
Revoke account {targetAccountNKeyPublic}'s share of subject export {subjectExportId}.
Unshare subject export {subjectExportId} from {targetAccountNKeyPublic}.

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-subject-export-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-subject-export-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-subject-export-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: API for Synadia Control Plane / Synadia Cloud
  title: Synadia Control Plane / Synadia Cloud Subject Export API
  version: beta
servers:
- description: Path to Synadia Control Plane Server Api
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: ''
security:
- bearerAuth: []
  sessionAuth: []
tags:
- name: subject-export
paths:
  /core/beta/subject-exports/{subjectExportId}:
    delete:
      operationId: deleteSubjectExport
      parameters:
      - explode: false
        in: path
        name: subjectExportId
        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 Subject Export
      tags:
      - subject-export
      x-doc-tags:
      - Sharing
    get:
      description: Returns Subject Export info
      operationId: getSubjectExport
      parameters:
      - explode: false
        in: path
        name: subjectExportId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectExportViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Get Subject Export
      tags:
      - subject-export
      x-doc-tags:
      - Sharing
    patch:
      operationId: updateSubjectExport
      parameters:
      - explode: false
        in: path
        name: subjectExportId
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubjectExportUpdateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectExportViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Update Subject Export
      tags:
      - subject-export
      x-doc-tags:
      - Sharing
  /core/beta/subject-exports/{subjectExportId}/shares:
    get:
      description: List subject shares for this export
      operationId: listSubjectShares
      parameters:
      - explode: false
        in: path
        name: subjectExportId
        required: true
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectShareListResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: List Subject Shares
      tags:
      - subject-export
      x-doc-tags:
      - Sharing
    post:
      description: Creates Subject Shares
      operationId: createSubjectShares
      parameters:
      - explode: false
        in: path
        name: subjectExportId
        required: true
        schema:
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubjectShareCreateRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubjectShareViewResponse'
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      summary: Create Subject Shares
      tags:
      - subject-export
      x-doc-tags:
      - Sharing
  /core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic}:
    delete:
      description: Revokes the share for account
      operationId: deleteSubjectShare
      parameters:
      - explode: false
        in: path
        name: subjectExportId
        required: true
        schema:
          type: string
        style: simple
      - explode: false
        in: path
        name: targetAccountNKeyPublic
        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 Subject Share
      tags:
      - subject-export
      x-doc-tags:
      - Sharing
components:
  schemas:
    ServiceLatencyPatch:
      properties:
        results:
          type: string
        sampling:
          maximum: 100
          minimum: 0
          type: integer
      type: object
    ServiceLatency:
      description: "ServiceLatency is used when observing and exported service for\nlatency measurements.\nSampling 1-100, represents sampling rate, defaults to 100.\nResults is the subject where the latency metrics are published.\nA metric will be defined by the nats-server's ServiceLatency. Time durations\nare in nanoseconds.\nsee https://github.com/nats-io/nats-server/blob/main/server/accounts.go#L524\ne.g.\n{\n \"app\": \"dlc22\",\n \"start\": \"2019-09-16T21:46:23.636869585-07:00\",\n \"svc\": 219732,\n \"nats\": {\n   \"req\": 320415,\n   \"resp\": 228268,\n   \"sys\": 0\n },\n \"total\": 768415\n}"
      example:
        sampling: 23
        results: results
      properties:
        results:
          type: string
        sampling:
          maximum: 100
          minimum: 0
          type: integer
      required:
      - results
      - sampling
      type: object
    AccountInfo:
      example:
        user_jwt: user_jwt
        auth_type: null
        user_cred: user_cred
        account_public_key: account_public_key
        name: name
        user_jwt_expires_in_secs: 0
        id: id
        is_platform_account: true
        is_scp_account: true
        is_system_account: true
      properties:
        account_public_key:
          type: string
        auth_type:
          $ref: '#/components/schemas/AccountAuthType'
        id:
          type: string
        is_platform_account:
          type: boolean
        is_scp_account:
          type: boolean
        is_system_account:
          type: boolean
        name:
          type: string
        user_cred:
          type: string
        user_jwt:
          type: string
        user_jwt_expires_in_secs:
          format: int64
          type: integer
      required:
      - auth_type
      - id
      - is_platform_account
      - is_scp_account
      - is_system_account
      - name
      - user_jwt_expires_in_secs
      type: object
    ExportPatch_service_latency:
      allOf:
      - $ref: '#/components/schemas/ServiceLatencyPatch'
      type:
      - object
      - 'null'
    SubjectExportUpdateRequest:
      example:
        jwt_settings:
          revocations: '{}'
          account_token_position: 0
          subject: subject
          name: name
          description: description
          response_type: null
          token_req: true
          type: null
          service_latency: null
          advertise: true
          info_url: info_url
          response_threshold: 2147483647
        metrics_sampling_percentage: 1
        metrics_enabled: true
      properties:
        jwt_settings:
          $ref: '#/components/schemas/ExportPatch'
        metrics_enabled:
          type: boolean
        metrics_sampling_percentage:
          format: int64
          type: integer
      type: object
    ExportPatch:
      example:
        revocations: '{}'
        account_token_position: 0
        subject: subject
        name: name
        description: description
        response_type: null
        token_req: true
        type: null
        service_latency: null
        advertise: true
        info_url: info_url
        response_threshold: 2147483647
      properties:
        account_token_position:
          minimum: 0
          type:
          - integer
          - 'null'
        advertise:
          type: boolean
        description:
          type:
          - string
          - 'null'
        info_url:
          type:
          - string
          - 'null'
        name:
          type: string
        response_threshold:
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          type:
          - integer
          - 'null'
        response_type:
          $ref: '#/components/schemas/ResponseType'
        revocations:
          allOf:
          - $ref: '#/components/schemas/RevocationListPatch'
          type:
          - object
          - 'null'
        service_latency:
          $ref: '#/components/schemas/ExportPatch_service_latency'
        subject:
          type: string
        token_req:
          type: boolean
        type:
          $ref: '#/components/schemas/ExportType'
      type: object
    AccountAuthType:
      enum:
      - jwt
      - tls
      - nkey
      - username
      type: string
    SubjectShareListResponse:
      example:
        items:
        - subject_export_id: subject_export_id
          created: 2000-01-23 04:56:07+00:00
          jwt: jwt
          id: id
          target_account_nkey_public: target_account_nkey_public
          jwt_claims:
            nats:
              kind: null
              subject: subject
              issuer_account: issuer_account
        - subject_export_id: subject_export_id
          created: 2000-01-23 04:56:07+00:00
          jwt: jwt
          id: id
          target_account_nkey_public: target_account_nkey_public
          jwt_claims:
            nats:
              kind: null
              subject: subject
              issuer_account: issuer_account
      properties:
        items:
          items:
            $ref: '#/components/schemas/SubjectShareViewResponse'
          type: array
      required:
      - items
      type: object
    ResponseType:
      description: ResponseType is used to store an export response type
      enum:
      - Singleton
      - Stream
      - Chunked
      type: string
    SubjectShareCreateRequest:
      example:
        target_account_nkey_public: target_account_nkey_public
      properties:
        target_account_nkey_public:
          type: string
      required:
      - target_account_nkey_public
      type: object
    ActivationClaims:
      allOf:
      - $ref: '#/components/schemas/ClaimsData'
      description: ActivationClaims holds the data specific to an activation JWT
      example:
        nats:
          kind: null
          subject: subject
          issuer_account: issuer_account
      properties:
        nats:
          $ref: '#/components/schemas/Activation'
      type: object
    Info:
      properties:
        description:
          type: string
        info_url:
          type: string
      type: object
    SubjectShareViewResponse:
      description: '/

        Subject Shares

        /'
      example:
        subject_export_id: subject_export_id
        created: 2000-01-23 04:56:07+00:00
        jwt: jwt
        id: id
        target_account_nkey_public: target_account_nkey_public
        jwt_claims:
          nats:
            kind: null
            subject: subject
            issuer_account: issuer_account
      properties:
        created:
          format: date-time
          type: string
        id:
          type: string
        jwt:
          type: string
        jwt_claims:
          $ref: '#/components/schemas/ActivationClaims'
        subject_export_id:
          type: string
        target_account_nkey_public:
          type: string
      required:
      - created
      - id
      - jwt
      - jwt_claims
      - subject_export_id
      - target_account_nkey_public
      type: object
    GenericFields:
      properties:
        tags:
          items:
            type: string
          type: array
        type:
          description: ClaimType is used to indicate the type of JWT being stored in a Claim
          type: string
        version:
          type: integer
      type: object
    Export:
      allOf:
      - $ref: '#/components/schemas/Info'
      description: Export represents a single export
      example:
        revocations:
          key: 5
        account_token_position: 0
        subject: subject
        name: name
        response_type: null
        token_req: true
        type: null
        service_latency:
          sampling: 23
          results: results
        advertise: true
        response_threshold: 5
      properties:
        account_token_position:
          minimum: 0
          type: integer
        advertise:
          type: boolean
        name:
          type: string
        response_threshold:
          format: int64
          type: integer
        response_type:
          $ref: '#/components/schemas/ResponseType'
        revocations:
          additionalProperties:
            format: int64
            type: integer
          description: RevocationList is used to store a mapping of public keys to unix timestamps
          type: object
        service_latency:
          $ref: '#/components/schemas/ServiceLatency'
        subject:
          type: string
        token_req:
          type: boolean
        type:
          $ref: '#/components/schemas/ExportType'
      type: object
    ExportType:
      description: ExportType defines the type of import/export.
      enum:
      - stream
      - service
      type: string
    RevocationListPatch:
      additionalProperties:
        maximum: 9223372036854775807
        minimum: -9223372036854775808
        type:
        - integer
        - 'null'
      type: object
    ClaimsData:
      description: ClaimsData is the base struct for all claims
      properties:
        aud:
          type: string
        exp:
          format: int64
          type: integer
        iat:
          format: int64
          type: integer
        iss:
          type: string
        jti:
          type: string
        name:
          type: string
        nbf:
          format: int64
          type: integer
        sub:
          type: string
      type: object
    Activation:
      allOf:
      - $ref: '#/components/schemas/GenericFields'
      description: Activation defines the custom parts of an activation claim
      example:
        kind: null
        subject: subject
        issuer_account: issuer_account
      properties:
        issuer_account:
          description: 'IssuerAccount stores the public key for the account the issuer represents.

            When set, the claim was issued by a signing key.'
          type: string
        kind:
          $ref: '#/components/schemas/ExportType'
        subject:
          type: string
      type: object
    SubjectExportViewResponse:
      description: '/

        Subject Exports

        /'
      example:
        share_sk_public: share_sk_public
        stream_export_id: stream_export_id
        created: 2000-01-23 04:56:07+00:00
        subject: subject
        jwt_settings:
          revocations:
            key: 5
          account_token_position: 0
          subject: subject
          name: name
          response_type: null
          token_req: true
          type: null
          service_latency:
            sampling: 23
            results: results
          advertise: true
          response_threshold: 5
        is_public: true
        name: name
        id: id
        metrics_sampling_percentage: 0
        metrics_enabled: true
        account:
          user_jwt: user_jwt
          auth_type: null
          user_cred: user_cred
          account_public_key: account_public_key
          name: name
          user_jwt_expires_in_secs: 0
          id: id
          is_platform_account: true
          is_scp_account: true
          is_system_account: true
      properties:
        account:
          $ref: '#/components/schemas/AccountInfo'
        created:
          format: date-time
          type: string
        id:
          type: string
        is_public:
          type: boolean
        jwt_settings:
          $ref: '#/components/schemas/Export'
        metrics_enabled:
          type: boolean
        metrics_sampling_percentage:
          format: int64
          type: integer
        name:
          type:
          - string
          - 'null'
        share_sk_public:
          type:
          - string
          - 'null'
        stream_export_id:
          type:
          - string
          - 'null'
        subject:
          type: string
      required:
      - account
      - created
      - id
      - is_public
      - jwt_settings
      - metrics_enabled
      - metrics_sampling_percentage
      - name
      - share_sk_public
      - stream_export_id
      - subject
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: Personal Access Token
      scheme: bearer
      type: http
    sessionAuth:
      in: cookie
      name: control_plane_session
      type: apiKey