Synadia Communications KV Management API

The KV Management API API from Synadia Communications — 5 operation(s) for kv management api.

Documentation 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

GET /kvm/buckets List all key-value stores · List all key value stores #

Ask an LLM

“What key-value stores exist on the NATS server?”

“Can I list every KV bucket through the HTTP gateway?”

Tell an agent

List all key-value stores.

Show me every KV store available.

GET /kvm/buckets/{bucket} Get metadata for a key-value store · Returns metadata on the key value store #

Ask an LLM

“How do I see a KV store's history depth, TTL and size?”

“What metadata does a key-value store report?”

Tell an agent

Show metadata for KV store {bucket}.

Get info about key-value store {bucket}.

POST /kvm/buckets/{bucket} Add a key-value store · Add a key value store #

Ask an LLM

“How do I create a KV store over the HTTP gateway?”

“Can I set a TTL and history depth when adding a key-value store?”

Tell an agent

Add key-value store {bucket}.

Add KV store {bucket} with a TTL of {ttl} and history {history}.

DELETE /kvm/buckets/{bucket} Delete a key-value store entirely · Delete a store, removing all keys #

Ask an LLM

“How do I delete a KV store along with all its keys?”

“Is there a way to drop a whole key-value store?”

Tell an agent destructive · confirm first

Delete KV store {bucket} and all its keys.

Destroy key-value store {bucket}.

DELETE /kvm/buckets/{bucket}/purge Purge deleted keys from a KV store · Purge a store removing all deleted keys #

Ask an LLM

“How do I clean up the tombstones of deleted keys in a KV store?”

“Can I purge removed keys while keeping live ones?”

Tell an agent destructive · confirm first

Purge deleted keys from KV store {bucket}.

Clean out the tombstones in key-value store {bucket}.

GET /kvm/buckets/{bucket}/keys List keys in a KV store · List all the keys in the store #

Ask an LLM

“What keys are in a given key-value store?”

“Can I filter a KV store's keys by a subject-style pattern?”

Tell an agent

List the keys in KV store {bucket}.

List keys in KV store {bucket} matching {filter}.

GET /kvm/buckets/{bucket}/watch Watch a KV store for changes · Watches for changes in the specified store #

Ask an LLM

“How do I get notified as keys change in a key-value store?”

“Can a watch resume from a specific revision and skip deletes?”

Tell an agent

Watch KV store {bucket} for changes.

Watch keys matching {filter} in KV store {bucket}.

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-kv-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

openapi: 3.2.0
info:
  title: NATS HTTP Gateway KV 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: KV Management API
paths:
  /kvm/buckets:
    get:
      operationId: ListKvStores
      tags:
      - KV Management API
      summary: List all key value 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
  /kvm/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: KvStoreInfo
      tags:
      - KV Management API
      summary: Returns metadata on the key value store
      responses:
        '200':
          headers:
            X-Nats-Kv-Name:
              schema:
                type: string
              description: the name of the bucket (only on application/text)
            X-Nats-Kv-Values:
              schema:
                type: number
              description: the number of entries in the KV - includes history (only on application/text)
            X-Nats-Kv-History:
              schema:
                type: number
              description: the number of possible history per key (only on application/text)
            X-Nats-Kv-Ttl:
              schema:
                type: string
              description: the amount of time entries live in the bucket (only on application/text)
            X-Nats-Kv-Backing-Store:
              schema:
                type: string
              description: the backing store for the KV (memory or disk) (only on application/text)
            X-Nats-Kv-Size:
              schema:
                type: number
              description: the size of the bucket in bytes (only on application/text)
            X-Nats-Kv-Compression:
              schema:
                type: boolean
              description: true if the KV is compressed (only on application/text)
          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
    post:
      operationId: AddKvStore
      tags:
      - KV Management API
      summary: Add a key value store
      parameters:
      - in: header
        name: X-Nats-Kv-Max-Value-Size
        schema:
          type: number
        description: the maximum size for an entry (only on application/text)
      - in: header
        name: X-Nats-Kv-History
        schema:
          type: number
        description: the number of possible history per key (only on application/text)
      - in: header
        name: X-Nats-Kv-Ttl
        schema:
          type: number
        description: the amount of time entries live in the bucket in nanoseconds (only on application/text)
      - in: header
        name: X-Nats-Kv-Max-Bytes
        schema:
          type: number
        description: the maximum size of the KV in bytes (only on application/text)
      - in: header
        name: X-Nats-Kv-Storage
        schema:
          type: string
          enum:
          - file
          - memory
        description: the underlying storage for the KV (only on application/text)
      - in: header
        name: X-Nats-Kv-Replicas
        schema:
          type: number
        description: the underlying number of replicas (only on application/text)
      - in: header
        name: X-Nats-Kv-Compression
        schema:
          type: boolean
        description: compress the KV store (only on application/text)
      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:
      - KV Management API
      summary: Delete a store, removing all keys
      operationId: KvStoreDestroy
      responses:
        '200':
          description: Success response
        '400':
          description: Invalid Request
        '404':
          description: Bucket doesn't exist
  /kvm/buckets/{bucket}/purge:
    delete:
      operationId: KvStorePurge
      tags:
      - KV Management API
      parameters:
      - in: path
        name: bucket
        description: Bucket name
        required: true
        style: simple
        explode: false
        schema:
          maximum: 1
          minimum: 1
          type: string
      summary: Purge a store removing all deleted keys
      responses:
        '200':
          description: Success response
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
  /kvm/buckets/{bucket}/keys:
    get:
      operationId: KvStoreKeys
      tags:
      - KV 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
      - name: filter
        in: query
        required: false
        style: form
        explode: true
        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
  /kvm/buckets/{bucket}/watch:
    get:
      operationId: KvStoreWatch
      tags:
      - KV 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
      - name: authorization
        in: query
        required: false
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success response
          content:
            text/event-stream:
              schema:
                type: object
                properties:
                  bucket:
                    type: string
                  created:
                    type: string
                    format: date-time
                  revision:
                    type: number
                    format: uint64
                  delta:
                    type: number
                    format: uint64
                  operation:
                    type: string
                    enum:
                    - PUT
                    - DEL
                    - PURGE
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header

Synadia Communications KV Management API

Operations 7

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification