Gateways

List All Gateways

This API returns an overview info for the specified or all gateways.<br/>including current running status, number of connections, listener status, etc.

get/gateways

Request

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

Query parameters

status'running' | 'stopped' | 'unloaded'

Filter gateways by status.<br/><br/>It is enum with running, stopped, unloaded

Response

namestring

Gateway Name

status'running' | 'stopped' | 'unloaded'

Gateway status

created_atstring

The Gateway created datetime

started_atstring

The Gateway started datetime

stopped_atstring

The Gateway stopped datetime

max_connectionsinteger

The Gateway allowed maximum connections/clients

current_connectionsinteger

The Gateway current connected connections/clients

Changes

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