list_alerts
const url = 'https://example.com/api/v1/alerts';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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/alerts \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Every active alert, each decorated with its inbound ack state
An active alert plus its inbound (read-only) ack state.
subject_kind and subject_name decompose the alert’s node field, which carries either a
node’s UUID, pool:<name> or meraki_org:<uuid>. The live alert stream emits the same three keys.
object
When it fired (Unix ms, UTC).
Numeric breach detail for a threshold alert; None for a liveness alert.
object
Which way the metric crossed its bound.
The bound crossed for the committed severity, if the rule defines one at that level.
Observed sample value that committed the transition.
The check that produced it.
Whether the underlying check is currently flapping.
Metric the check measured (e.g. "icmp_rtt_ms"; the liveness sentinel for up/down).
Carried for the history log + notification payload so a human can read what fired —
not part of alert identity (dedup/grouping ignore it).
What the alert is about: a node’s UUID, or pool:<name> for a poller-pool alert.
The row of a vendor table this alert is about — a memory pool, a CPU, a sensor — as the row
key its samples carry; None for an alert about the whole node or about a port.
What that row was called when the alert fired (I/O, MPU Board 0); None when the row has
no name yet or the alert is not about a row.
Severity (derived from the committed state).
The committed state that triggered the alert.
The acknowledgement view attached to an alert / history row in API responses. Carries who acked it, when, from which external tool, and an optional note. Never carries a secret.
object
When the external tool recorded the ack (Unix ms, UTC).
External actor reference (id / handle) — not a secret.
Optional free-text note from the external tool.
Originating tool: pagerduty | jsm | manual | …
The name of the port a per-port alert is about (ifName), read from the interface inventory
when the alert is read rather than stored with it (ADR-196 decision 6). Absent for an alert
about no port, and for a port whose name is not known.
What this alert is about: a monitored node, or Yagra’s own polling coverage for a pool.
The subject’s name, for a subject identified by name rather than by id (a poller pool).
What the alert is called, in English — SNMP not responding rather than snmp_up
(ADR-196). The metric’s own name when Yagra has none for it; absent for an alert with no
metric at all.
Example
[ { "breach": { "direction": "above" }, "severity": "info", "state": "ok", "subject_kind": "node" }]No valid bearer token
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Role lacks the read permission
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}