ConstantsEvents

listAlarmDefinitions

GET
/api/v1/const/alarm_defs

Return alarm type definitions used by alarm search results, alarm templates, and the alarm webhook topic. The example field shows representative webhook payload content. HA cluster node names are returned in the node field, when applicable.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Response Body

curl -X GET "https://example.com/api/v1/const/alarm_defs"
[  {    "display": "Device offline",    "example": {      "aps": [        "d420b02000fa"      ],      "count": 1,      "group": "infrastructure",      "hostnames": [        "Vendor_AP2"      ],      "id": "e70c308f-7007-4866-9ecd-0d01842979ea",      "last_seen": 1629753888,      "org_id": "09dac91f-6e73-4100-89f7-698e0fafbb1b",      "severity": "warn",      "site_id": "dcfb31a1-d615-4361-8c95-b9dde05aa704",      "timestamp": 1629753888,      "type": "device_down"    },    "fields": [      "aps",      "hostnames"    ],    "group": "infrastructure",    "key": "device_down",    "marvis_suggestion_category": "string",    "severity": "warn"  }]