Alarms

List currently activated alarms or historical alarms, determined by query parameters.

get/alarms

Request

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

activatedboolean

It is used to specify the alarm type of the query.<br/>When true, it returns the currently activated alarm,<br/>and when it is false, it returns the historical alarm.<br/>The default is false.

Response

Example response

{
  "data": [
    {
      "node": "emqx@127.0.0.1",
      "name": "high_system_memory_usage",
      "message": "System memory usage is higher than 70%",
      "details": {
        "high_watermark": 70
      },
      "duration": 297056,
      "activate_at": "2021-10-25T11:52:52.548+08:00",
      "deactivate_at": "2021-10-31T10:52:52.548+08:00"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50
  }
}

Changes

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