getAlarmDefinitions
GET https://{{host}}/api/v1/const/alarm_defs
Get brief definitions of all the supported alarm types. The example field contains an example payload as you would recieve in the alarm webhook output.
Response Parameters
| Name | Type | Description |
|---|---|---|
key | string | Key name of an alarm type |
display | string | Description of the alarm type |
group | string | Group to which the alarm belongs |
marvis_suggestion_category | string | Marvis defined category to which the alarm belongs |
severity | string | Severity of the alarm |
fields | list | (optional)List of fields available in an alarm details payload (in REST APIs & Webhooks); e.g. aps, switches, gateways, hostnames, ssids, bssids etc; see [Site:Get Alarms:Additional Information] for more details |
RESPONSES
status: OK
"[\n {\n \"key\": \"device_down\",\n \"display\": \"Device offline\",\n \"group\": \"infrastructure\",\n \"severity\": \"warn\",\n \"example\": {\n \"severity\": \"warn\",\n \"timestamp\": 1629753888,\n \"last_seen\": 1629753888,\n \"aps\": [\n \"d420b02000fa\"\n ],\n \"org_id\": \"09dac91f-6e73-4100-89f7-698e0fafbb1b\",\n \"site_id\": \"dcfb31a1-d615-4361-8c95-b9dde05aa704\",\n \"count\": 1,\n \"hostnames\": [\n \"Vendor_AP2\"\n ],\n \"id\": \"f70c308f-7007-4866-9ecd-0d01842979ea\",\n \"type\": \"device_down\",\n \"group\": \"infrastructure\"\n },\n \"fields\": [\n \"aps\",\n \"hostnames\"\n ]\n },\n ...\n]"