Get Consumer Info

GET

///v1/admin/consumers/:consumer_type

Get detailed information about a specific consumer.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Path parameters

consumer_typeenumRequired

Valid consumer types for NATS consumer management.

Allowed values:

Response

Operation successful

namestring

num_ack_pendinginteger

num_deliveredinteger

num_pendinginteger

streamstring

subjectstring

Errors

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

1	{
2	"name": "nautobot_consumer_01",
3	"num_ack_pending": 12,
4	"num_delivered": 3450,
5	"num_pending": 7,
6	"stream": "events_stream",
7	"subject": "nautobot.updates"
8	}