Sign in

v7

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

Session detail

Returns full detail for a single session or active AMQP 0.9.1 connection. MQTT sessions include subscriptions, inflight count, and offline queue depth. AMQP 0.9.1 connections include connection_name and active consumer filters. The client ID must be URL-encoded if it contains special characters (e.g. slashes).

get/api/v1/sessions/{client_id}

Path parameters

client_idstring required

MQTT client identifier (URL-encoded)

Response

Session detail

client_idstring
connection_namestring

Human-readable AMQP 0.9.1 connection name, when provided by the client

state'connected' | 'disconnected'
connectedboolean
protocol'mqtt3.1' | 'mqtt3.1.1' | 'mqtt5' | 'amqp0.9.1' | 'amqp1.0' | 'unknown'
versioninteger

Raw protocol version byte (3, 4, or 5)

clean_startboolean

MQTT-only session setting

expiry_intervalinteger

MQTT-only session expiry interval in seconds (0 = no expiry)

connected_atstring date-time nullable
disconnected_atstring date-time nullable
receive_maximuminteger

MQTT-only flow control setting

max_packet_sizeinteger

MQTT-only packet size limit

topic_alias_maxinteger

MQTT-only topic alias limit

request_responseboolean

MQTT 5 request/response capability flag

request_problemboolean

MQTT 5 problem information capability flag

has_willboolean

MQTT-only flag indicating whether the session has a will message

subscription_countinteger

Number of active MQTT subscriptions or AMQP 0.9.1 consumers

inflight_countinteger

MQTT-only inflight publish count

offline_queue_depthinteger

MQTT-only offline queue depth

Example response

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