v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_Alarms

Get list of alarm rules

⚠️ Android only.

Returns a paginated list of all alarm rules configured in the enterprise. Alarm rules define the conditions under which device or fleet alerts are triggered — specifying which metric to monitor, the threshold conditions, which devices or groups are in scope, and which alert channels receive notifications when the rule fires.

Key Query parameters

name (optional) — Filter rules by name

description (optional) — Filter rules by description

is_active (optional) — Filter by active (true) or inactive (false) rules

Response fields of note

id — UUID identifying the alarm rule; used in all subsequent rule operations

name / description — Display name and description for the rule

metric — The device metric being monitored (e.g., battery level, connectivity)

conditions — Threshold definition including value, unit, comparator, and toggle_state

devices / groups — The specific devices or device groups the rule applies to

alert_channels — Array of alert channel IDs that receive notifications when the rule fires

action_emails — Direct email recipients for notifications, independent of alert channels

is_active — Whether the rule is currently enabled

realert_interval — Interval in minutes before the rule re-alerts if the condition persists

repeat_times — Number of times the alert will repeat

trigger_count / daily_trigger_count — Cumulative and daily counts of how many times the rule has fired

Common use cases

Auditing all active alarm rules across the enterprise to review monitoring coverage

Retrieving rule IDs for use in get, update, patch, or delete operations

Filtering for inactive rules to identify stale or disabled monitoring configurations

Reviewing trigger counts to assess alert frequency and rule health

Best practices

Use is_active=true to scope results to currently enabled rules when auditing live monitoring configuration

Use created_on_gt / created_on_lt to scope results to a specific time window when reviewing recently added or historical rules

Note that alarm_id used in single-rule operations is a UUID, unlike the integer alert_id used by alert channels

get/v1/enterprise/{enterprise_id}/alarmrules/

Path parameters

enterprise_idstring required

A UUID string identifying this enterprise.

Query parameters

namestring

Filter alarm rules by name.

descriptionstring

Filter alarm rules by description.

is_activeboolean

Filter active alarm rules.

created_on_gtstring

Filter alarm rules created after a given timestamp.

created_on_ltstring

Filter alarm rules created before a given timestamp.

limitinteger

Number of results to return per page.

offsetinteger

Return results from this index.

Response

successful operation

countinteger required
nextstring url nullable
previousstring url nullable