Get information about a stream

Retrieves detailed information about a specific stream, including its configuration and current state. This endpoint provides metrics such as the number of messages, bytes used, first and last sequence numbers, and more.

GET /storage/streams/{name}

Get information about a stream

cURL

curl --request GET \
  --url https://api.quiva.ai/storage/streams/{name} \
  --header 'Authorization: Bearer <token>'

200

active_stream

{
  "body": {
    "config": {
      "name": "user-events",
      "description": "User activity events",
      "subjects": [
        "events.user.*"
      ],
      "retention": "Limits",
      "max_consumers": -1,
      "max_msgs": 1000000,
      "max_bytes": 104857600,
      "max_age": 0,
      "max_msg_size": -1,
      "storage": "file",
      "discard": "old",
      "num_replicas": 3,
      "duplicate_window": 120000000000,
      "deny_delete": false,
      "deny_purge": false
    },
    "state": {
      "messages": 15420,
      "bytes": 2458320,
      "first_seq": 1,
      "first_ts": "2024-01-15T10:30:00Z",
      "last_seq": 15420,
      "last_ts": "2024-03-15T14:22:33Z",
      "consumer_count": 3,
      "num_subjects": 12
    },
    "created": "2024-01-15T10:30:00Z",
    "cluster": {
      "name": "nats-cluster",
      "leader": "nats-1",
      "replicas": [
        {
          "name": "nats-2",
          "current": true,
          "active": 0
        },
        {
          "name": "nats-3",
          "current": true,
          "active": 0
        }
      ]
    }
  }
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · string · required

Name of the stream

Response

200

application/json

Successfully retrieved stream information

body · object