v7

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

Subscriptions

List subscriptions

Returns aggregated MQTT subscriptions and AMQP 0.9.1 active consumer filters grouped by filter, with subscriber count and max QoS for each row. By default, only connected clients are included (state=connected).

get/api/v1/subscriptions

Query parameters

state'all' | 'connected' | 'disconnected'

Filter by client session state (connected by default)

prefixstring

Filter by subscription filter prefix

limitinteger

Maximum number of subscription rows (0 = no limit)

page_tokenstring

Cursor token from a previous response's next_page_token

Response

Paginated list of aggregated subscriptions

next_page_tokenstring

Cursor for the next page (empty if no more results)

Example response

{
  "subscriptions": [
    {
      "filter": "devices/+/events",
      "subscriber_count": 42,
      "max_qos": 1
    }
  ]
}