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 Server API

The Server API from NATS — 2 operation(s) for server.

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

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

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.10.0.

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

2 operations 2 paths 1 schemas 2 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 2

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

Server 2
GET
/varz
General server information
getVarz → 200
GET
/ipqueuesz
IP queue sizes
getIpqueuesz → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Varz (26 properties). Each schema is shown below with its type and property counts.

Varz
object
26 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nats-server-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 Clustering API
NATS Connections API
NATS Gateways API
NATS Health API
NATS JetStream API
NATS Leaf Nodes API