Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NATS Clustering API

Cluster, gateway, and leaf node endpoints

NATS Clustering API is one of 15 APIs that NATS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clustering. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.10.0.

Requests are made against a single base URL, http://localhost:8222.

3 operations 3 paths 3 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.10.0
Base URL
http://localhost:8222
Contact
License
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Clustering 3

Cluster, gateway, and leaf node endpoints

GET
/routez
NATS Get route information
getRoutes 1 param → 200
GET
/gatewayz
NATS Get gateway information
getGateways 2 params → 200
GET
/leafz
NATS Get leaf node information
getLeafNodes 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Gatewayz (7 properties), Routez (4 properties), Leafz (4 properties). Each schema is shown below with its type and property counts.

Gatewayz
object
7 properties
Leafz
object
4 properties
Routez
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nats-clustering-api-openapi.yml Raw ↑

Other APIs NATS publishes across the network.

NATS Monitoring API
NATS Messaging API
NATS JetStream Management API
NATS Key-Value Store API
NATS Object Store API
NATS Accounts API
NATS Connections API
NATS Gateways API
NATS Health API
NATS JetStream API
NATS Leaf Nodes API
NATS Routes API