v1

latestOpenAPI 3.0.2GNU Free Documentation License2026-07-176924101.2 KB
Alarms

List alarms

Returns alarms with optional filtering. Supports filtering by object, state, time range, key, and message.

get/alarms

Query parameters

objectIdinteger

Filter by source object ID

objectGuidstring uuid

Filter by source object GUID

includeChildObjectsboolean

Include alarms from child objects

statestring

Comma-separated states: outstanding, acknowledged, resolved, terminated (or 0-3)

createdBeforeinteger

Filter alarms created before timestamp (Unix epoch seconds)

createdAfterinteger

Filter alarms created after timestamp (Unix epoch seconds)

updatedBeforeinteger

Filter alarms updated before timestamp (Unix epoch seconds)

updatedAfterinteger

Filter alarms updated after timestamp (Unix epoch seconds)

keystring

Filter by alarm key (glob pattern)

keyRegexstring

Filter by alarm key (regex pattern)

messagestring

Filter by alarm message (regex pattern)

resolveReferencesboolean

Include resolved object, user, and event template references

Response

List of alarms