Clients

Get clients info by client ID

get/clients/{clientid}

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/clients/{clientid}
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

clientidstring required

Response

awaiting_rel_cntinteger

v4 api name [awaiting_rel] Number of awaiting PUBREC packet

awaiting_rel_maxinteger

v4 api name [max_awaiting_rel]. Maximum allowed number of awaiting PUBREC packet

clean_startboolean

Indicate whether the client is using a brand new session

clientidstring

Client identifier

connectedboolean

Whether the client is connected

expiry_intervalinteger

Session expiration interval, with the unit of second

heap_sizeinteger

Process heap size with the unit of byte

inflight_cntinteger

Current length of inflight

inflight_maxinteger

v4 api name [max_inflight]. Maximum length of inflight

ip_addressstring

Client's IP address

is_bridgeboolean

Indicates whether the client is connectedvia bridge

keepaliveinteger

keepalive time, with the unit of second

mailbox_leninteger

Process mailbox size

mqueue_droppedinteger

Number of messages dropped by the message queue due to exceeding the length

mqueue_leninteger

Current length of message queue

mqueue_maxinteger

v4 api name [max_mqueue]. Maximum length of message queue

nodestring

Name of the node to which the client is connected

portinteger

Client's port

proto_namestring

Client protocol name

proto_verinteger

Protocol version used by the client

recv_cntinteger

Number of TCP packets received

recv_msginteger

Number of PUBLISH packets received

recv_msg.droppedinteger

Number of dropped PUBLISH packets

recv_msg.dropped.await_pubrel_timeoutinteger

Number of dropped PUBLISH packets due to expired

recv_msg.qos0integer

Number of PUBLISH QoS0 packets received

recv_msg.qos1integer

Number of PUBLISH QoS1 packets received

recv_msg.qos2integer

Number of PUBLISH QoS2 packets received

recv_octinteger

Number of bytes received

recv_pktinteger

Number of MQTT packets received

reductionsinteger

Erlang reduction

send_cntinteger

Number of TCP packets sent

send_msginteger

Number of PUBLISH packets sent

send_msg.droppedinteger

Number of dropped PUBLISH packets

send_msg.dropped.expiredinteger

Number of dropped PUBLISH packets due to expired

send_msg.dropped.queue_fullinteger

Number of dropped PUBLISH packets due to queue full

send_msg.dropped.too_largeinteger

Number of dropped PUBLISH packets due to packet length too large

send_msg.qos0integer

Number of PUBLISH QoS0 packets sent

send_msg.qos1integer

Number of PUBLISH QoS1 packets sent

send_msg.qos2integer

Number of PUBLISH QoS2 packets sent

send_octinteger

Number of bytes sent

send_pktinteger

Number of MQTT packets sent

subscriptions_cntinteger

Number of subscriptions established by this client.

subscriptions_maxinteger

v4 api name [max_subscriptions] Maximum number of subscriptions allowed by this client

usernamestring

User name of client when connecting

mountpointstring

Topic mountpoint

zonestring

Indicate the configuration group used by the client

Example response

{
  "connected_at": 1640995200000,
  "created_at": 1640995200000,
  "disconnected_at": 1640995200000
}

Changes

No recorded changes to this operation across all 1 revision of this API.