List event rules
const url = 'https://example.com/api/v1/event-rules';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/event-rulesLists the event rules, the authored config that raises alarms, each with its live state as counts (conditions_in_force, open_alarms, pending_streaks) read in the same query. Rules read like a registry: every rule is listed whatever the caller’s scope, while the counts cover only components the caller may read. Gated by rule:read.
Responses
Section titled “ Responses ”OK
object
A URL to the JSON Schema for this object.
object
A URL to the JSON Schema for this object.
When the sample meets this for clear_sustain, the condition ends (and the alarm clears); absent, the negation of fire_criteria
object
The criterion, an expression over the sample (value, key, instance, component.name, component.type) that yields true or false, e.g. value > 80 && instance != “aux”
The event type the rule writes when its condition ends, by name; absent, it writes none
How long the clear criteria must hold, a Go duration
How many conditions the rule holds in force right now, one per component and instance, whether or not it raises an alarm (GET /event-rules/{name}/state lists them)
Why the rule’s stored criteria do not compile (its key’s data type changed under them, a row the backfill left in short form, or an expression a newer diagnostic refuses); absent when they compile. While present the rule holds: it judges nothing
object
The registered diagnostic that gave it, when one did (documented on the expressions page)
The 1-based column of the fault, when it has one
Which criteria
The 1-based line of the fault, when it has one
The warnings the stored criteria compile with (a likely mistake, such as == against a decimal), each with its code; notes only, never a fault: the rule judges all the same
object
The registered diagnostic that gave it, when one did (documented on the expressions page)
The 1-based column of the fault, when it has one
Which criteria
The 1-based line of the fault, when it has one
When the sample meets this for fire_sustain, the rule’s condition starts (and it opens an alarm when it names a severity)
object
The criterion, an expression over the sample (value, key, instance, component.name, component.type) that yields true or false, e.g. value > 80 && instance != “aux”
The event type the rule writes when its condition starts, by name
How long the fire criteria must hold, a Go duration (0s fires at once)
The rule’s uuid, the stable form of name
When an ingested sample was last judged by the rule, to within 5s; absent when it never has been. A fleet-wide fact about the rule, naming no component
The alarm’s message; empty uses the rule’s label or name
Shipped with the platform and read-only
How many alarms the rule raised are still open right now (its live state; GET /event-rules/{name}/state lists them)
How many of the rule’s streaks are waiting out a sustain right now
The property or metric the rule reads
Which lane the key reads, derived from the registries
The components the rule watches; both lists empty is every component
object
Watch components whose type falls within one of these component types
Watch these components (by name or id on write; ids on read)
The severity level the alarm is raised at, by name; absent, the rule is informational and raises no alarm
Bumps on every update
Example
{ "$schema": "/api/v1/schemas/ListEventRulesOutputBody.json", "event_rules": [ { "$schema": "/api/v1/schemas/EventRuleBody.json", "criteria_error": { "field": "fire_criteria" }, "criteria_warnings": [ { "field": "fire_criteria" } ], "sample_lane": "property" } ]}default
Section titled “default ”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{ "$schema": "/api/v1/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}