Get instance of alarm rule
⚠️ Android only.
Returns the full details of a single alarm rule identified by its UUID alarm_id, including the monitored metric, threshold conditions, target devices or groups, linked alert channels, notification settings, and cumulative trigger counts. Use this endpoint to inspect a rule's current configuration before updating it, or to check trigger activity for a specific rule.
Response fields of note
id — UUID identifying the alarm rule
name / description — Display name and description
metric — The device metric being monitored
conditions — Threshold definition including value, unit, comparator, and toggle_state
devices / groups — The specific devices or groups the rule applies to
alert_channels — Alert channel IDs receiving notifications when the rule fires
action_emails — Direct email recipients independent of alert channels
is_active — Whether the rule is currently enabled
realert_interval — Minutes before re-alerting if the condition persists
repeat_times — Number of times the alert repeats
trigger_count / daily_trigger_count — Cumulative and daily counts of how many times the rule has fired
Common use cases
Retrieving a rule's current configuration before issuing an update or patch
Inspecting trigger_count and daily_trigger_count to assess how frequently the rule is firing
Confirming a rule was created correctly after a POST /alarmrules/ call
Checking which devices, groups, and alert channels are currently associated with a rule
Best practices
Always retrieve the current state of a rule before updating it to avoid overwriting fields unintentionally when using PUT
Use GET /alarmrules/ with the name filter to locate an alarm_id if it is not already known — note that alarm_id is a UUID, unlike the integer alert_id used by alert channels
For a history of when and on which devices the rule has fired, use GET /alarmrules/{alarm_id}/alarmhistory/ rather than relying solely on trigger_count
Path parameters
A UUID string identifying this enterprise.
A UUID string identifying the alarm ruleset.
Response
successful operation