List a component's alarms

GET

/components/{name}/alarms

const url = 'https://example.com/api/v1/components/example/alarms';
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/components/example/alarms

What is currently wrong with this component, newest first. Pass include_cleared for the history rather than the active set. Gated by component:read; an out-of-scope component is a non-disclosing 404.

Parameters

Path Parameters

name

required

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

string

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

Query Parameters

include_cleared

Include cleared alarms, so the list is the history rather than what is wrong now

boolean

Include cleared alarms, so the list is the history rather than what is wrong now

unacknowledged

Only the alarms nobody has looked at. On its own this is the queue an operator works (raised and unacknowledged); with include_cleared it also returns the incidents that came and went unattended

boolean

Only the alarms nobody has looked at. On its own this is the queue an operator works (raised and unacknowledged); with include_cleared it also returns the incidents that came and went unattended

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

alarms

required

Array<object> | null

object

$schema

A URL to the JSON Schema for this object.

string format: uri

acknowledged

required

Whether anybody has recorded seeing this alarm; says nothing about whether it is still raised

boolean

acknowledged_at

When a human first recorded seeing this alarm; null while nobody has. Independent of cleared_at

string format: date-time

acknowledged_by

Who acknowledged it, by name; empty while unacknowledged, or once that principal has been purged (the audit log keeps the name)

string

active

required

boolean

cleared_at

Null while the alarm is active

string format: date-time

component

required

string

dedup_key

required

The condition identity: one open alarm per (component, dedup_key)

string

required

string

message

required

string

raised_at

required

string format: date-time

severity

required

Info, warning, or critical

string

component

required

string

Example

{
  "$schema": "/api/v1/schemas/ListAlarmsOutputBody.json",
  "alarms": [
    {
      "$schema": "/api/v1/schemas/AlarmBody.json"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

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"
}