Read an alarm's timeline

GET

/components/{name}/alarms/{id}:timeline

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

The alarm’s history in one list, oldest first: the events that carry it (an event rule’s fire event, which opened it, and its clear event, which resolved it) merged by time with its audit rows (the raise, each acknowledgement, the clear, and a rule edit that opened or resolved it, naming the editor). At one instant an event comes before the audit row it caused. Gated by alarm:read; a component outside the caller’s component read scope, and an alarm not on the component, are 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)

required

The alarm id

string

The alarm id

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

alarm_id

required

string

component

required

string

entries

required

Oldest first; at one instant an event comes before the audit row it caused

Array<object> | null

object

actor

Who acted, by name; absent when the platform acted for a rule

string

required

When it happened

string format: date-time

instance

The series instance (an endpoint) an event is about

string

kind

required

An event carrying the alarm (a rule’s fire or clear event), or an audit row about it

string

Allowed values: event audit

message

The event’s message, or the message the alarm was raised with

string

rule

The event rule the entry belongs to, by name: the rule that wrote the event, or the rule the platform acted for

string

what

required

The event’s type (e.g. condition-started), or the audit action: raise, acknowledge or clear

string

Example

{
  "$schema": "/api/v1/schemas/AlarmTimelineOutputBody.json",
  "entries": [
    {
      "kind": "event"
    }
  ]
}

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