For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • NVIDIA Switch Infrastructure
    • I want to...
  • Quick Start
    • Start Here
    • Getting Started with Config Manager
    • TUI Wizard Reference
    • Configuration Samples
    • Interfaces
    • Local Development Quick Start
    • First Run Tour
  • Config Manager Overview
    • Config Manager Concepts
    • Getting Started with Nautobot
  • User Guides
    • New Site Bringup
    • Workflow Lifecycle
  • Deployment
    • Hosting Options
    • Network Topology Requirements
    • Firewall Ports
    • Airgapped Deployment
    • Troubleshooting
  • Services
      • Network Template Rendering System
      • Render Service
      • Filter quick reference
      • Template expansion
        • GETHealthcheck
        • GETCurrent User Info
          • GETList Consumers
          • DELReset All Consumers
          • GETGet Consumer Info
          • DELReset Consumer
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
ServicesTemplate Rendering ServiceRender Service APIadmin

List Consumers

||View as Markdown|
GET
https://host.com/v1/admin/consumers
GET
/v1/admin/consumers
$curl https://host.com/v1/admin/consumers \
>     -H "Content-Type: application/json"
1{
2  "consumers": [
3    {
4      "name": "order_processor_consumer",
5      "num_ack_pending": 5,
6      "num_delivered": 1500,
7      "num_pending": 12,
8      "stream": "orders_stream",
9      "subject": "orders.created"
10    }
11  ]
12}
List all consumers and their current status.
Previous

Current User Info

Next

Reset All Consumers

Response

Operation successful
consumerslist of objects

Errors

404
Not Found Error
500
Internal Server Error