getSiteAlarms
GET https://{{host}}/api/v1/sites/:site_id/alarms/search
Response Parameters
| Parameter | Type | Description |
|---|
| results | list | List of result objects |
| id | list | UUID of the alarm |
| site_id | string | UUID of the site |
| org_id | string | UUID of the org |
| type | string | Key-name of the alarm type |
| group | string | Group of the alarm |
| severity | string | Severity of the alarm |
| count | int | Number of incident within an alarm window |
| timestamp | long | Epoch (seconds) of the first incident/alarm |
| last_seen | long | Epoch (seconds) of the last incident/alarm within an alarm window |
| acked | boolean | (optional)Whether the alarm is acked or not |
| acked_time | long | (optional)Epoch (seconds) when the alarm was acked |
| ackadminname | string | (optional)Name & Email ID of the admin who acked the alarm |
| ackadminid | string | (optional)UUID of the admin who acked the alarm |
| note | string | (optional)Text describing the alarm |
Additional Information Parameters
| Parameter | Type | Description |
|---|
| aps | list | List of MACs of the APs e.g. [“ffeeddccbbaa”, “ffeeddccbbab”] |
| switches | list | List of MACs of the switches e.g. [“ffeeddccbbaa”, “ffeeddccbbab”] |
| gateways | list | List of MACs of the gateways e.g. [“ffeeddccbbaa”, “ffeeddccbbab”] |
| hostnames | string | List of Hostnames of the devices (AP/Switch/Gateway) |
| ssids | list | List of SSIDs |
| bssids | list | List of BSSIDs |
Request Params
| Key | Datatype | Required | Description |
|---|
type | null | | string, Key-name of the alarms; accepts multiple values separated by comma |
ack_admin_name | null | | string, Name of the admins who have acked the alarms; accepts multiple values separated by comma |
acked | null | | boolean |
group | null | | string, Alarm group name; accepts multiple values separated by comma |
severity | null | | string, 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"}]}