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

Change an alert destination

The URL and the recipients cannot change: remove the destination and add it again. Turning global off for the last global destination is allowed; deliveryConfigured then reports false.

PATCH/api/v1/alert-delivery/destinations/{id}
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idinteger<int64>required
Request body
requiredapplication/json
globalboolean

Omit to keep

minSeveritystring

Omit to keep

Allowed:warningcritical
namestring

1 to 64 characters after trimming. Omit to keep

Responses
200

OK

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
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 PATCH 'https://console.example.com/api/v1/alert-delivery/destinations/0' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "global": true,
  "minSeverity": "warning",
  "name": "string"
}'
Response
{
  "display": "string",
  "global": true,
  "id": 0,
  "kind": "webhook",
  "minSeverity": "warning",
  "name": "string",
  "usedBy": [
    {
      "serviceId": "string",
      "serviceName": "string"
    }
  ]
}