Alerts alerts

Recent alert and recovery events, kept for 30 days.

Pick an endpoint to see its example call on the right.

Node schedulingAuthentication: Admin only1 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/alertsList recent alerts and recoveries

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
rulestring Filter by rule name.
kindAlertKind Filter by kind: fire for alerts, resolve for recoveries.
Values ["fire","resolve"]

Alerts object

FieldTypeDescription
created_atstring Created at
detailstring Additional details.
idinteger Record ID
kindAlertKind fire: alert fired; resolve: recovered.
Values ["fire","resolve"]
msg_idinteger Notification sent (in-app message ID).
rulestring Alert rule key.
subjectstring Subject the alert is about, such as a node or site.
thresholdnumber Threshold of the rule.
titlestring Chinese name of the rule (same as rule when the rule no longer exists).
unitstring Unit of the value and threshold.
valuenumber Value that triggered the alert.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command