Clients

List clients

get/clients

Request

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

Query parameters

pageinteger

Page number of the results to fetch.

limitinteger

Results per page(max 1000)

nodestring

Node name

usernamestring

User name

zonestring
ip_addressstring

Client's IP address

conn_state'connected' | 'idle' | 'disconnected'

The current connection status of the client, the possible values are connected,idle,disconnected

clean_startboolean

Whether the client uses a new session

proto_verstring

Client protocol version

like_clientidstring

Fuzzy search clientid as substring

like_usernamestring

Fuzzy search username as substring

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Search client session creation time by greater than or equal method, rfc3339 or timestamp(millisecond)

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Search client session creation time by less than or equal method, rfc3339 or timestamp(millisecond)

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Search client connection creation time by greater than or equal method, rfc3339 or timestamp(epoch millisecond)

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Search client connection creation time by less than or equal method, rfc3339 or timestamp(millisecond)

Response

Example response

{
  "data": [
    {
      "connected_at": 1640995200000,
      "created_at": 1640995200000,
      "disconnected_at": 1640995200000
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50
  }
}

Changes

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