FluxMQ
ReferenceAdmin API

Admin

Broker statistics, cluster topology, and combined overview

GET
/api/v1/stats

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/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      },      "local_principals": {        "active_connections": 0,        "publish_timeouts": 0,        "publish_rejections": 0,        "authentication": {          "success": 0,          "failure": 0        },        "authorization": {          "publish_denied": 0,          "subscribe_denied": 0,          "operation_denied": 0        },        "reloads": {          "success": 0,          "failure": 0,          "forced_disconnects": 0        }      }    }  },  "queues": {    "capture_failures": 0,    "capture_dropped": 0,    "claims": {      "attempts": 0,      "successes": 0,      "failures": 0    },    "steals": {      "attempts": 0,      "successes": 0,      "failures": 0    },    "acknowledgments": {      "ack": 0,      "nack": 0,      "reject": 0,      "dlq": 0    },    "pending": {      "current": 0,      "high_water": 0    }  }}
{  "error": "broker not available"}
{  "error": "broker not available"}
GET
/api/v1/cluster

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/cluster"
{  "node_id": "node-1",  "cluster_mode": true,  "is_leader": true,  "nodes": [    {      "id": "node-1",      "address": "10.0.0.1:7946",      "healthy": true,      "leader": true,      "uptime_seconds": 86400.5    }  ]}
{  "error": "broker not available"}
{  "error": "broker not available"}
GET
/api/v1/overview

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/overview"
{  "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        },        "local_principals": {          "active_connections": 0,          "publish_timeouts": 0,          "publish_rejections": 0,          "authentication": {            "success": 0,            "failure": 0          },          "authorization": {            "publish_denied": 0,            "subscribe_denied": 0,            "operation_denied": 0          },          "reloads": {            "success": 0,            "failure": 0,            "forced_disconnects": 0          }        }      }    },    "queues": {      "capture_failures": 0,      "capture_dropped": 0,      "claims": {        "attempts": 0,        "successes": 0,        "failures": 0      },      "steals": {        "attempts": 0,        "successes": 0,        "failures": 0      },      "acknowledgments": {        "ack": 0,        "nack": 0,        "reject": 0,        "dlq": 0      },      "pending": {        "current": 0,        "high_water": 0      }    }  },  "cluster": {    "nodes": [      {        "id": "node-1",        "address": "10.0.0.1:7946",        "healthy": true,        "leader": true,        "uptime_seconds": 86400.5      }    ]  }}
{  "error": "broker not available"}
{  "error": "broker not available"}