How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Synadia Cloud NATS HTTP Gateway

A first-class RESTful HTTP interface to NATS, hosted by Synadia Cloud at api.ngs.global. 30 operations expose the NATS key-value store and its management surface, the object store and its management surface, and core NATS publish, request and subscribe against any subject over HTTP. Authenticated with an API token scoped to a User within an Account, passed in the Authorization header.

This API exposes 30 operations across 14 paths, organized into 7 resource areas, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.ngs.global/v1.

30 operations 14 paths 11 schemas 7 DELETE13 GET5 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.ngs.global/v1
Authentication
API Key
Resource Areas
7

Authentication & Security 1

Synadia Cloud NATS HTTP Gateway declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 30

Across 14 paths, the API surfaces 30 operations — 7 DELETE, 13 GET, 5 POST, 5 PUT. They span 7 resource areas: KV API, KV Management API, Extended KV Entry Operations, ObjectStore API, ObjectStore Management API, ObjectStore Entry Operations, NATS Core Messaging (Experimental). Each is listed below with its method, path, parameters, and response codes.

KV API 4
GET
/kv/{bucket}/{key}
Retrieves a value from the key value store.
SimpleKvGet 3 params → 200400404
POST
/kv/{bucket}/{key}
Adds a new entry to the key value store, fails if the entry exists.
SimpleKvCreateEntry 2 params body → 201400409
PUT
/kv/{bucket}/{key}
Adds or updates an existing entry at an optional revision
SimpleKvPutEntry 3 params body → 201400409
DELETE
/kv/{bucket}/{key}
Delete an entry
SimpleKvDeleteEntry 3 params → 200400
KV Management API 7
GET
/kvm/buckets
List all key value stores
ListKvStores → 200400
GET
/kvm/buckets/{bucket}
Returns metadata on the key value store
KvStoreInfo 1 param → 200
POST
/kvm/buckets/{bucket}
Add a key value store
AddKvStore 8 params body → 200400
DELETE
/kvm/buckets/{bucket}
Delete a store, removing all keys
KvStoreDestroy 1 param → 200400404
DELETE
/kvm/buckets/{bucket}/purge
Purge a store removing all deleted keys
KvStorePurge 1 param → 200400
GET
/kvm/buckets/{bucket}/keys
List all the keys in the store
KvStoreKeys 2 params → 200400
GET
/kvm/buckets/{bucket}/watch
Watches for changes in the specified store
KvStoreWatch 6 params → 200400
Extended KV Entry Operations 4
GET
/kvm/buckets/{bucket}/keys/{key}
Retrieves a value from the key value store.
KvGetEntry 3 params → 200400404
POST
/kvm/buckets/{bucket}/keys/{key}
Adds a new entry to the key value store, fails if the entry exists.
KvCreateEntry 2 params body → 201400409
PUT
/kvm/buckets/{bucket}/keys/{key}
Creates or updates an entry in the key value store at an optional revision
KvPutEntry 3 params body → 200201400409
DELETE
/kvm/buckets/{bucket}/keys/{key}
Delete an entry
KvDeleteEntry 3 params → 200400
ObjectStore API 3
GET
/obj/{bucket}/{key}
SimpleObjGet 3 params → 200400404
PUT
/obj/{bucket}/{key}
Adds or updates an existing entry at an optional revision
SimpleObjPutEntry 4 params body → 200400
DELETE
/obj/{bucket}/{key}
Delete an entry
SimpleObjDeleteEntry 3 params → 200400404
ObjectStore Management API 6
GET
/objm/buckets
List all object stores
ObjmList → 200400
GET
/objm/buckets/{bucket}
Returns metadata on the object store
ObjmStoreInfo 2 params → 200
POST
/objm/buckets/{bucket}
Add an object store
ObjmStoreAdd 2 params body → 200400
DELETE
/objm/buckets/{bucket}
Delete an object store, removing all keys
ObjmStoreDestroy 1 param → 200400
GET
/objm/buckets/{bucket}/keys
List all the keys in the store
ObjStoreKeys 1 param → 200400
GET
/objm/buckets/{bucket}/watch
Watches for changes in the specified store
ObjStoreWatch 5 params → 200400
ObjectStore Entry Operations 3
GET
/objm/buckets/{bucket}/keys/{key}
ObjGetEntry 2 params → 200400404
PUT
/objm/buckets/{bucket}/keys/{key}
Adds or updates an entry to the object store,
ObjCreateEntry 2 params body → 200400
DELETE
/objm/buckets/{bucket}/keys/{key}
Delete an entry
ObjDeleteEntry 3 params → 200400404
NATS Core Messaging (Experimental) 3
POST
/nats/subjects/{subject}
Makes a request
request 3 params body → 200400
PUT
/nats/subjects/{subject}
Publishes a message with an optional reply
publish 6 params body → 200400
GET
/nats/subjects/{subject}
Creates a subscription
subscribe 4 params → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ObjectInfo (12 properties), BucketConfig (9 properties), Bucket (7 properties), ValueEvent (5 properties). Each schema is shown below with its type and property counts.

ValueEvent
object
5 properties
Value
Error
object
1 property
Bucket
object
7 properties
Metadata
object
BucketConfig
object
9 properties
ObjectLink
object
2 properties
ObjectInfo
object
12 properties
Unknown
object
Header
object
Msg
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synadia-communications-http-gateway-openapi.json Raw ↑
Where this information came from

This is an independent, third-party profile of Synadia Cloud NATS HTTP Gateway, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.