Version 2.1.1792967583 · latest Download OpenAPI Markdown

Alerts

Recent alert and recovery events, kept for 30 days.

alertsNode schedulingAuthentication: Admin only1 endpoints

List recent alerts and recoveries

GET/api/v2/alerts
Authentication: Admin only

Query parameters

FieldTypeRequiredDescription
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

FieldTypeRequiredDescription
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.