NATS website screenshot

NATS

A high-performance, cloud-native messaging system for microservices, IoT, and edge computing. Provides pub-sub, request-reply, and queue-based messaging patterns with at-most-once and at-least-once delivery guarantees.

5 APIs 0 Features
Cloud NativeIoTMessage BrokerMicroservicesPub Sub

APIs

NATS Monitoring API

HTTP monitoring API providing real-time server status, connection information, route details, subscription statistics, JetStream metrics, and health check endpoints for observab...

NATS Messaging API

Asynchronous messaging API supporting core pub-sub, request-reply, queue groups, and JetStream persistent messaging with streams, consumers, key-value stores, and object stores.

NATS JetStream Management API

The JetStream wire API provides a protocol-level management interface for configuring and operating JetStream streams, consumers, key-value buckets, and object stores. Requests ...

NATS Key-Value Store API

The NATS Key-Value Store API is a JetStream-backed abstraction that provides immediately consistent, persistent associative array semantics. Clients can create buckets, get, put...

NATS Object Store API

The NATS Object Store API is a JetStream-backed abstraction for storing and retrieving arbitrarily large binary objects using a chunking mechanism. Objects are identified by a b...

Collections

Pricing Plans

Nats Plans Pricing

8 plans

PLANS

Rate Limits

Nats Rate Limits

8 limits

RATE LIMITS

FinOps

Nats Finops

FINOPS

Event Specifications

NATS Core and JetStream Messaging API

NATS provides cloud-native messaging with core pub-sub, request-reply, and queue group patterns, plus JetStream for persistent streaming with streams, consumers, key-value store...

ASYNCAPI

Resources

🔗
Website
Website
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
👥
GitHubRepository
GitHubRepository
📰
Blog
Blog
🔗
Slack
Slack
🔗
Issues
Issues
📄
ChangeLog
ChangeLog
💻
Examples
Examples
🔗
CLI
CLI
👥
GitHubOrganization
GitHubOrganization
🔗
JSONSchema
JSONSchema
🔗
JSONSchema
JSONSchema
🔗
JSONSchema
JSONSchema
🔗
JSONSchema
JSONSchema
🔗
JSONLD
JSONLD
💬
Support
Support
📜
PrivacyPolicy
PrivacyPolicy
🔗
Community
Community
📦
SDKs
SDKs
🔗
Download
Download
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: NATS Monitoring HTTP API
  version: 2.10.0
items:
- info:
    name: Server
    type: folder
  items:
  - info:
      name: General server information
      type: http
    http:
      method: GET
      url: http://localhost:8222/varz
    docs: Returns general information about the server state including memory, connections, message rates, and configuration.
  - info:
      name: IP queue sizes
      type: http
    http:
      method: GET
      url: http://localhost:8222/ipqueuesz
    docs: Reports sizes of internal IP queues.
- info:
    name: Connections
    type: folder
  items:
  - info:
      name: Connection information
      type: http
    http:
      method: GET
      url: http://localhost:8222/connz
      params:
      - name: sort
        value: ''
        type: query
      - name: auth
        value: ''
        type: query
      - name: subs
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: cid
        value: ''
        type: query
      - name: state
        value: ''
        type: query
    docs: Reports detailed information on current and recently closed connections.
- info:
    name: Routes
    type: folder
  items:
  - info:
      name: Route information
      type: http
    http:
      method: GET
      url: http://localhost:8222/routez
      params:
      - name: subs
        value: ''
        type: query
    docs: Reports information on active routes for a cluster.
- info:
    name: Gateways
    type: folder
  items:
  - info:
      name: Gateway information
      type: http
    http:
      method: GET
      url: http://localhost:8222/gatewayz
      params:
      - name: accs
        value: ''
        type: query
      - name: gw_name
        value: ''
        type: query
    docs: Reports information about gateway connections for a super-cluster.
- info:
    name: Leaf Nodes
    type: folder
  items:
  - info:
      name: Leaf node information
      type: http
    http:
      method: GET
      url: http://localhost:8222/leafz
      params:
      - name: subs
        value: ''
        type: query
    docs: Reports information about leaf node connections.
- info:
    name: Subscriptions
    type: folder
  items:
  - info:
      name: Subscription information
      type: http
    http:
      method: GET
      url: http://localhost:8222/subsz
      params:
      - name: subs
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: test
        value: ''
        type: query
    docs: Reports detailed information about current subscriptions and the routing data structure.
- info:
    name: JetStream
    type: folder
  items:
  - info:
      name: JetStream information
      type: http
    http:
      method: GET
      url: http://localhost:8222/jsz
      params:
      - name: acc
        value: ''
        type: query
      - name: accounts
        value: ''
        type: query
      - name: streams
        value: ''
        type: query
      - name: consumers
        value: ''
        type: query
      - name: config
        value: ''
        type: query
      - name: leader-only
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: Reports information about JetStream configuration, usage, and streams.
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Account information
      type: http
    http:
      method: GET
      url: http://localhost:8222/accountz
      params:
      - name: acc
        value: ''
        type: query
    docs: Reports information about accounts.
- info:
    name: Health
    type: folder
  items:
  - info:
      name: Health check
      type: http
    http:
      method: GET
      url: http://localhost:8222/healthz
      params:
      - name: js-enabled-only
        value: ''
        type: query
      - name: js-server-only
        value: ''
        type: query
    docs: Returns 200 OK if the server is healthy, or an error status otherwise.
bundled: true