getSiteAlarms

GET https://{{host}}/api/v1/sites/:site_id/alarms/search

Response Parameters

ParameterTypeDescription
resultslistList of result objects
idlistUUID of the alarm
site_idstringUUID of the site
org_idstringUUID of the org
typestringKey-name of the alarm type
groupstringGroup of the alarm
severitystringSeverity of the alarm
countintNumber of incident within an alarm window
timestamplongEpoch (seconds) of the first incident/alarm
last_seenlongEpoch (seconds) of the last incident/alarm within an alarm window
ackedboolean(optional)Whether the alarm is acked or not
acked_timelong(optional)Epoch (seconds) when the alarm was acked
ackadminnamestring(optional)Name & Email ID of the admin who acked the alarm
ackadminidstring(optional)UUID of the admin who acked the alarm
notestring(optional)Text describing the alarm

Additional Information Parameters

ParameterTypeDescription
apslistList of MACs of the APs e.g. [“ffeeddccbbaa”, “ffeeddccbbab”]
switcheslistList of MACs of the switches e.g. [“ffeeddccbbaa”, “ffeeddccbbab”]
gatewayslistList of MACs of the gateways e.g. [“ffeeddccbbaa”, “ffeeddccbbab”]
hostnamesstringList of Hostnames of the devices (AP/Switch/Gateway)
ssidslistList of SSIDs
bssidslistList of BSSIDs

Request Params

KeyDatatypeRequiredDescription
typenullstring, Key-name of the alarms; accepts multiple values separated by comma
ack_admin_namenullstring, Name of the admins who have acked the alarms; accepts multiple values separated by comma
ackednullboolean
groupnullstring, Alarm group name; accepts multiple values separated by comma
severitynullstring, Alarm severity; accepts multiple values separated by comma

RESPONSES

status: OK

{"results":[{"id":"8a93ab2d-b745-a093-7936-80d7922559b5","timestamp":1431382121,"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","type":"device-down","count":3,"acked":true,"acked_time":1431388121,"ack_admin_name":"FirstName LastName first.last@someorg.com","ack_admin_id":"ab6fdaa0-e7c4-428b-9259-7d7a603afa8a","note":"upgrade switch"}]}