Banned

List all currently banned client IDs, usernames and IP addresses.

get/banned

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/banned
  • 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)

Response

Example response

{
  "data": [
    {
      "as": "username",
      "who": "Banned name",
      "by": "mgmt_api",
      "reason": "Too many requests",
      "at": 1640995200,
      "until": 1640995200
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50
  }
}

Changes

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