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

Get alert destinations

Never returns a stored URL. The destinations are bearer credentials and the console is reachable by anyone holding a session, so returning one would make reading a credential out a single request.

GET/api/v1/alert-delivery
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

destinationsAlertDestinationResponse[]required
Show properties
Array of AlertDestinationResponse
displaystringrequired

Redacted form: scheme and host only; for email, masked addresses

globalbooleanrequired

Receives the alerts of every service that inherits, and every alert with no service

idinteger<int64>required
kindstringrequired
Allowed:webhookslackmsteamsemail
minSeveritystringrequired

Lowest severity delivered here

Allowed:warningcritical
namestringrequired

The operator's label for the destination

usedByAlertServiceRef[]required

Services that assign this destination

Show properties
Array of AlertServiceRef
serviceIdstringrequired
serviceNamestringrequired
watchdogRedactedURLrequired
Show properties
configuredbooleanrequired
displaystringrequired

Redacted form: scheme and host only

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/alert-delivery' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "destinations": [
    {
      "display": "string",
      "global": true,
      "id": 0,
      "kind": "webhook",
      "minSeverity": "warning",
      "name": "string",
      "usedBy": [
        {
          "serviceId": "string",
          "serviceName": "string"
        }
      ]
    }
  ],
  "watchdog": {
    "configured": true,
    "display": "string"
  }
}