Skip to content
sigiro
Esc
↑↓navigate↵open⌘Jpreview

List alerts

GET/v1/alerts
Authorization
AuthorizationBearer token (prefixed-api-key) · headerrequired
Query parameters
statusstring

Filter by lifecycle status: firing or resolved.

Responses
200

Alert instances

alertsAlertInstance[]required
Show properties
Array of AlertInstance
container_namestringrequired
ends_atstring | null
fingerprintstringrequired
occurrence_countinteger<int64>required
min 0
rule_idstringrequired
service_namestringrequired
starts_atstringrequired
statusstringrequired
400

Invalid status filter

401

Missing or invalid bearer token

Request
curl -X GET '/v1/alerts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "alerts": [
    {
      "container_name": "string",
      "ends_at": "string",
      "fingerprint": "string",
      "occurrence_count": 0,
      "rule_id": "string",
      "service_name": "string",
      "starts_at": "string",
      "status": "string"
    }
  ]
}

Was this page helpful?