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

Set service alert overrides

The body is the full override: an unlisted rule inherits. replace with no destination is refused, because the service’s alerts would go nowhere. The values that result for the service must be valid. Regenerates and reloads the rule file and the routing config. A change of the routing needs the admin role; an operator on the service sends the stored routing.

PUT/api/v1/database-services/{id}/alert-overrides
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Request body
requiredapplication/json
routingAlertRoutingInputrequired
Show properties
destinationIdsinteger<int64>[]

Ignored for inherit

modestringrequired

replace: only the assigned destinations; add: the assigned and the global destinations

Allowed:inheritreplaceadd
rulesAlertRuleOverrideInput[]

The full set of rule overrides; an unlisted rule inherits

Show properties
Array of AlertRuleOverrideInput
enabledboolean | null

Omit or null to inherit

namestringrequired
severitystring | null

Omit or null to inherit

Allowed:warningcritical
thresholdinteger<int64> | null

Omit or null to inherit

Responses
200

OK

mutedUntilstring | nullrequired

RFC3339; null when the service is not muted or the alert router cannot be reached

routingAlertRoutingrequired
Show properties
destinationIdsinteger<int64>[]required

Empty for inherit

modestringrequired

replace: only the assigned destinations; add: the assigned and the global destinations

Allowed:inheritreplaceadd
rulesAlertRuleOverride[]required

Every rule that a service can override

Show properties
Array of AlertRuleOverride
effectiveAlertRuleEffectiverequired

The values the rule uses for this service

Show properties
enabledbooleanrequired
severitystringrequired
thresholdinteger<int64> | nullrequired

null when the rule has no threshold

enabledboolean | nullrequired

null inherits

namestringrequired
severitystring | nullrequired

null inherits

Allowed:warningcritical
thresholdinteger<int64> | nullrequired

null inherits

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 PUT 'https://console.example.com/api/v1/database-services/string/alert-overrides' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "routing": {
    "destinationIds": [
      0
    ],
    "mode": "inherit"
  },
  "rules": [
    {
      "enabled": true,
      "name": "string",
      "severity": "warning",
      "threshold": 0
    }
  ]
}'
Response
{
  "mutedUntil": "string",
  "routing": {
    "destinationIds": [
      0
    ],
    "mode": "inherit"
  },
  "rules": [
    {
      "effective": {
        "enabled": true,
        "severity": "string",
        "threshold": 0
      },
      "enabled": true,
      "name": "string",
      "severity": "warning",
      "threshold": 0
    }
  ],
  "serviceId": "string",
  "serviceName": "string"
}