Gateway Clients

List Gateway's Clients

Get the gateway client list

get/gateways/{name}/clients

Request

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

Path parameters

namestring required

Gateway Name

Query parameters

nodestring

Match the client's node name

clientidstring

Match the client's ID

usernamestring

Match the client's Username

ip_addressstring

Match the client's ip address

conn_statestring

Match the client's connection state

proto_verstring

Match the client's protocol version

clean_startboolean

Match the client's clean start flag

like_clientidstring

Use sub-string to match client's ID

like_usernamestring

Use sub-string to match client's username

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Match the session created datetime greater than a certain value

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Match the session created datetime less than a certain value

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Match the client socket connected datetime greater than a certain value

integer

epoch-millisecond

OR
string date-time
Example:1640995200000

Match the client socket connected datatime less than a certain value

endpoint_namestring

Match the lwm2m client's endpoint name

like_endpoint_namestring

Use sub-string to match lwm2m client's endpoint name

gte_lifetimestring

Match the lwm2m client registered lifetime greater than a certain value

lte_lifetimestring

Match the lwm2m client registered lifetime less than a certain value

pageinteger

Page number of the results to fetch.

limitinteger

Results per page(max 1000)

Response

OR
OR
OR
OR

Example response

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

Changes

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