v1

latestOpenAPI 3.0.02026-07-2681914.7 KB

Alarms

Get a page of alarms

Retrieves a paginated list of alarms. Can be filtered by various parameters.

get/alarms

pageinteger

The page number of results to return (zero-based).

sizeinteger

The number of results to return per page.

sortstring

Example:timestamp_occured,asc

The parameter and direction to sort results by.

statusstring[]

Filter by the status of the alarm.

suppressedboolean

Filter alarms by the suppressed flag.

rule_intentstring

Filter by the intent of the rule that triggered the alarm.

rule_methodstring

Filter by the method of the rule that triggered the alarm.

rule_strategystring

Filter by the strategy of the rule that triggered the alarm.

priority_labelstring[]

Filter by the priority of the alarm.

alarm_sensor_sourcesstring uuid

Filter by the UUID of the sensor.

timestamp_occured_gteinteger

Filter for alarms that occurred at or after this timestamp (epoch milliseconds).

timestamp_occured_lteinteger

Filter for alarms that occurred at or before this timestamp (epoch milliseconds).

A paginated list of alarms.