v7

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-01103129.3 KB
Admin

Dashboard overview

Combined endpoint for dashboard landing pages — avoids multiple round trips. Composes stats, cluster topology, and combined MQTT + AMQP 0.9.1 session counts into a single response.

get/api/v1/overview

Response

Combined broker overview

node_idstring
cluster_modeboolean
is_leaderboolean
uptime_secondsnumber double

Example response

{
  "node_id": "node-1",
  "cluster_mode": true,
  "is_leader": true,
  "uptime_seconds": 86400.5,
  "sessions": {
    "connected": 342,
    "total": 500
  },
  "stats": {
    "uptime_seconds": 86400.5,
    "connections": {
      "current": 342,
      "total": 15000,
      "disconnections": 14658
    },
    "messages": {
      "received": 1250000,
      "sent": 980000
    },
    "bytes": {
      "received": 524288000,
      "sent": 412000000
    },
    "errors": {
      "protocol": 12
    },
    "by_protocol": {
      "mqtt": {
        "connections": {
          "current": 342,
          "total": 15000,
          "disconnections": 14658
        },
        "messages": {
          "received": 1100000,
          "sent": 850000,
          "publish_received": 1000000,
          "publish_sent": 800000
        },
        "bytes": {
          "received": 524288000,
          "sent": 412000000
        },
        "subscriptions": {
          "active": 1200,
          "retained_messages": 45
        },
        "errors": {
          "protocol": 12,
          "auth": 5,
          "authz": 3,
          "packet": 8
        }
      },
      "amqp": {
        "connections": {
          "current": 342,
          "total": 15000,
          "disconnections": 14658
        },
        "messages": {
          "received": 1250000,
          "sent": 980000
        },
        "bytes": {
          "received": 524288000,
          "sent": 412000000
        },
        "channels": 42,
        "consumers": 15,
        "errors": {
          "protocol": 12
        }
      }
    }
  },
  "cluster": {
    "nodes": [
      {
        "id": "node-1",
        "address": "10.0.0.1:7946",
        "healthy": true,
        "leader": true,
        "uptime_seconds": 86400.5
      }
    ]
  }
}