Synadia Communications

Synadia Communications ObjectStore Management API

The ObjectStore Management API API from Synadia Communications — 4 operation(s) for objectstore management api.

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

GET /objm/buckets List all object stores · List all object stores #
Ask an LLM
“What object store buckets do I have?”
“Can I list every object store in the account?”
Tell an agent
List all object stores.
Show me my object store buckets.
GET /objm/buckets/{bucket} Get an object store's metadata · Returns metadata on the object store #
Ask an LLM
“How big is an object store and what are its settings?”
“Can I see the metadata of one object store bucket?”
Tell an agent
Show metadata for object store {bucket}.
Get info about object store bucket {bucket}.
POST /objm/buckets/{bucket} Create an object store · Add an object store #
Ask an LLM
“How do I create a new object store bucket?”
“Can I set a TTL, size limit, replicas or compression on a new object store?”
Tell an agent
Create object store {bucket}.
Create object store {bucket} with {replicas} replicas and max size {max_bytes}.
DELETE /objm/buckets/{bucket} Delete an object store and all its objects · Delete an object store, removing all keys #
Ask an LLM
“Can I delete an entire object store including every object in it?”
“What's the way to destroy an object store bucket?”
Tell an agent destructive · confirm first
Delete object store {bucket} and all its keys.
Destroy object store bucket {bucket}.
GET /objm/buckets/{bucket}/keys List the objects in an object store · List all the keys in the store #
Ask an LLM
“What objects are stored in my object store?”
“Can I list every key in an object store bucket?”
Tell an agent
List the keys in object store {bucket}.
Show all objects stored in bucket {bucket}.
GET /objm/buckets/{bucket}/watch Watch an object store for changes · Watches for changes in the specified store #
Ask an LLM
“Can I get notified as objects change in an object store?”
“Is it possible to resume watching from a given revision and ignore deletes?”
Tell an agent
Watch object store {bucket} for changes.
Watch object store {bucket} for changes matching {filter}.

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-objectstore-management-api-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-objectstore-management-api-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-objectstore-management-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NATS HTTP Gateway ObjectStore Management API
  description: 'This is the API for interacting with NATS and NATS

    based services using HTTP.'
  version: 1.0.0
servers:
- url: https://api.ngs.global/v1
security:
- ApiKeyAuth: []
tags:
- name: ObjectStore Management API
paths:
  /objm/buckets:
    get:
      operationId: ObjmList
      tags:
      - ObjectStore Management API
      summary: List all object stores
      responses:
        '200':
          description: List of entity names
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                x-content-type: application/json
            application/text:
              schema:
                type: string
                x-content-type: application/text
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
  /objm/buckets/{bucket}:
    parameters:
    - in: path
      name: bucket
      description: Bucket name
      required: true
      style: simple
      explode: false
      schema:
        maximum: 1
        minimum: 1
        type: string
    get:
      operationId: ObjmStoreInfo
      tags:
      - ObjectStore Management API
      summary: Returns metadata on the object store
      parameters:
      - in: path
        name: bucket
        description: Bucket name
        required: true
        style: simple
        explode: false
        schema:
          maximum: 1
          minimum: 1
          type: string
      responses:
        '200':
          headers:
            X-Nats-Obj-Backing-Store:
              schema:
                type: string
                description: the backing store type - only set for application/text requests
            X-Nats-Obj-Name:
              schema:
                type: string
                description: the name of the bucket - only set for application/text requests
            X-Nats-Obj-TTl:
              schema:
                type: string
                description: the ttl for entries in the bucket in nanoseconds (0 doesn't expire) - only set for application/text requests
            X-Nats-Obj-Replicas:
              schema:
                type: number
                description: the number of replicas for the bucket - only set for application/text requests
            X-Nats-Obj-Size:
              schema:
                type: number
                description: the size of the bucket in bytes - only set for application/text requests
            X-Nats-Obj-Meta-:
              schema:
                type: string
                description: the metadata for the bucket, all keys in metadata are prefixed by `X-Nats-Obj-Meta-` - only set for application/text requests
          description: Success response
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  values:
                    type: number
                    format: uint64
                  history:
                    type: number
                    format: uint8
                  ttl:
                    type: number
                    format: int64
                  backing_store:
                    type: string
                  size:
                    type: number
                    format: uint64
                  compression:
                    type: boolean
            application/text:
              schema:
                type: string
                x-content-type: application/text
    post:
      operationId: ObjmStoreAdd
      tags:
      - ObjectStore Management API
      summary: Add an object store
      parameters:
      - in: path
        name: bucket
        description: Bucket name
        required: true
        style: simple
        explode: false
        schema:
          maximum: 1
          minimum: 1
          type: string
      requestBody:
        description: key store configuration
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                max_value_size:
                  type: number
                  format: int32
                history:
                  type: number
                  format: uint8
                ttl:
                  type: number
                  format: int64
                max_bytes:
                  type: number
                  format: uint64
                storage:
                  type: string
                  enum:
                  - file
                  - memory
                replicas:
                  type: number
                  format: int
                compression:
                  type: boolean
                metadata:
                  type: object
                  additionalProperties:
                    type: string
                  x-schema-name: Metadata
      responses:
        '200':
          description: Success response
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
    delete:
      tags:
      - ObjectStore Management API
      summary: Delete an object store, removing all keys
      operationId: ObjmStoreDestroy
      responses:
        '200':
          description: Success response
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
  /objm/buckets/{bucket}/keys:
    get:
      operationId: ObjStoreKeys
      tags:
      - ObjectStore Management API
      summary: List all the keys in the store
      parameters:
      - in: path
        name: bucket
        description: Bucket name
        required: true
        style: simple
        explode: false
        schema:
          maximum: 1
          minimum: 1
          type: string
      responses:
        '200':
          description: List of entity names
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                x-content-type: application/json
            application/text:
              schema:
                type: string
                x-content-type: application/text
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
  /objm/buckets/{bucket}/watch:
    get:
      operationId: ObjStoreWatch
      tags:
      - ObjectStore Management API
      summary: Watches for changes in the specified store
      parameters:
      - in: path
        name: bucket
        description: Bucket name
        required: true
        style: simple
        explode: false
        schema:
          maximum: 1
          minimum: 1
          type: string
      - name: filter
        in: query
        required: false
        style: form
        explode: true
        schema:
          maximum: 1
          minimum: 1
          type: string
      - name: include
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - lastValue
          - allHistory
          - updatesOnly
      - name: ignoreDeletes
        in: query
        required: false
        explode: true
        schema:
          type: boolean
      - name: resumeRevision
        in: query
        required: false
        explode: true
        schema:
          type: number
          format: uint64
      responses:
        '200':
          description: Success response
          content:
            text/event-stream:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  description:
                    type: string
                  metadata:
                    type: object
                    additionalProperties:
                      type: string
                    x-schema-name: Metadata
                  link:
                    type: object
                    properties:
                      bucket:
                        type: string
                      name:
                        type: string
                  max_chunk_size:
                    type: number
                    format: uint32
                  bucket:
                    type: string
                  nuid:
                    type: string
                  size:
                    type: number
                    format: uint64
                  mtime:
                    type: string
                    format: date-time
                  chunks:
                    type: number
                    format: uint32
                  digest:
                    type: string
                  deleted:
                    type: boolean
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header