countSiteAlarms
Count alarms for a site, optionally grouped by the distinct field and filtered by time range. Use Count Org Alarms to count alarms across the organization.
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
Path Parameters
uuidQuery Parameters
Field used to group this count response. enum: acked, group, severity, type
"type"Value in
- "acked"
- "group"
- "severity"
- "type"
Name of the admins who have acked the alarms; accepts multiple values separated by comma
Filter alarm results by whether the alarm has been acknowledged
Key-name of the alarms; accepts multiple values separated by comma
Alarm severity; accepts multiple values separated by comma
Alarm group name; accepts multiple values separated by comma
Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"Maximum number of results to return per page
0 <= value100Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/alarms/count"{ "distinct": "string", "end": 0, "limit": 0, "results": [ { "count": 0, "property": "string" } ], "start": 0, "total": 0}ackSiteAllAlarms POST
Ack all Site Alarms **N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.
searchSiteAlarms GET
Search alarms for a site with filters for alarm group, severity, type, acknowledgement state, acknowledgement admin, and time range. Use [Search Org Alarms](/api/mist/orgs/orgs-alarms/searchOrgAlarms) to search alarms across the organization.