Alerts alerts
Recent alert and recovery events, kept for 30 days.
Pick an endpoint to see its example call on the right.
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.
/api/v2/alertsList recent alerts and recoveries
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
rule | string | Filter by rule name. |
kind | AlertKind | Filter by kind: fire for alerts, resolve for recoveries. |
Alerts object
| Field | Type | Description |
|---|---|---|
created_at | string | Created at |
detail | string | Additional details. |
id | integer | Record ID |
kind | AlertKind | fire: alert fired; resolve: recovered. |
msg_id | integer | Notification sent (in-app message ID). |
rule | string | Alert rule key. |
subject | string | Subject the alert is about, such as a node or site. |
threshold | number | Threshold of the rule. |
title | string | Chinese name of the rule (same as rule when the rule no longer exists). |
unit | string | Unit of the value and threshold. |
value | number | 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.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"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"
}