Skip to content
You're viewing documentation for v2026.11.8-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get alerts and their state

Everything the alerts page and the global indicator need, in one response. Polled by the console, so it makes two upstream calls and a few database reads.

GET/api/v1/alerts
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

deliveryConfiguredbooleanrequired

At least one global destination is stored

engineReachablebooleanrequired
plannedOperationsPlannedSilencesViewrequired
Show properties
enabledbooleanrequired

The console silences the expected alerts of a service while a planned operation of the service runs

silencesPlannedSilenceView[]required

One entry for each operation with silences, also in the grace after its end. Empty when the alert router cannot be reached.

Show properties
Array of PlannedSilenceView
operationstringrequired

The operation, for example service upgrade

runningbooleanrequired

false in the grace after the end of the operation

serviceIdstringrequired
serviceNamestringrequired
untilstringrequired

RFC3339: the end of the silences

workflowIdstringrequired

Empty for an action with no workflow, for example a rolling restart

rulesAlertRuleStatus[]required
Show properties
Array of AlertRuleStatus
errorstring
forstringrequired

The rule's duration; empty when it has none

groupstringrequired
instancesAlertInstance[]required
Show properties
Array of AlertInstance
inhibitedbooleanrequired

Another firing alert holds back this instance

labelsobjectrequired

Identity labels of this firing series

silencedbooleanrequired

A silence matches this instance

sincestringrequired

When this instance entered its current state (RFC3339)

statestringrequired

pending while the rule's duration runs, then firing

Allowed:pendingfiring
valuestringrequired

The evaluated figure, which is what makes the alert actionable

namestringrequired
severitystringrequired

warning or critical; empty for the heartbeat

statusstringrequired
Allowed:okpendingtriggeredunknownheartbeatdisabled
summarystringrequired
summaryAlertCountsrequired
Show properties
okinteger<int64>required
pendinginteger<int64>required
triggeredinteger<int64>required
unknowninteger<int64>required
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/alerts' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "deliveryConfigured": true,
  "engineReachable": true,
  "plannedOperations": {
    "enabled": true,
    "silences": [
      {
        "operation": "string",
        "running": true,
        "serviceId": "string",
        "serviceName": "string",
        "until": "string",
        "workflowId": "string"
      }
    ]
  },
  "rules": [
    {
      "error": "string",
      "for": "string",
      "group": "string",
      "instances": [
        {
          "inhibited": true,
          "labels": {
            "property1": "string",
            "property2": "string"
          },
          "silenced": true,
          "since": "string",
          "state": "pending",
          "value": "string"
        }
      ],
      "name": "string",
      "severity": "string",
      "status": "ok",
      "summary": "string"
    }
  ],
  "summary": {
    "ok": 0,
    "pending": 0,
    "triggered": 0,
    "unknown": 0
  }
}