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

Test an alert destination

Reports the real HTTP result. A delivery failure is a 200 with delivered: false, because “no, the host refused the connection” is a successful answer to the question the operator asked.

POST/api/v1/alert-delivery/destinations/{id}/test
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idinteger<int64>required
Responses
200

OK

deliveredbooleanrequired
errorstring
statusCodeinteger<int64>
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 POST 'https://console.example.com/api/v1/alert-delivery/destinations/0/test' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "delivered": true,
  "error": "string",
  "statusCode": 0
}