v7

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

Sessions

List sessions

Returns MQTT v3/v5 sessions and active AMQP 0.9.1 connections with optional filtering by state and client ID prefix. Supports cursor-based pagination via page_token.

get/api/v1/sessions

Query parameters

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

Filter by session state

prefixstring

Filter sessions whose client ID starts with this prefix

limitinteger

Maximum number of sessions to return (0 = no limit)

page_tokenstring

Cursor token from a previous response's next_page_token

Response

Paginated list of sessions

next_page_tokenstring

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

Example response

{
  "sessions": [
    {
      "client_id": "my-device-001",
      "connection_name": "orders-consumer",
      "state": "connected",
      "connected": true,
      "protocol": "mqtt5",
      "version": 5,
      "subscriptions": [
        {
          "filter": "devices/+/events",
          "qos": 1
        }
      ]
    }
  ]
}