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 · cookierequiredPath parameters
idinteger<int64>requiredRequest body
requiredapplication/jsonglobalbooleanOmit to keep
minSeveritystringOmit to keep
Allowed:
warningcriticalnamestring1 to 64 characters after trimming. Omit to keep
Responses
200
OK
displaystringrequiredRedacted form: scheme and host only; for email, masked addresses
globalbooleanrequiredReceives the alerts of every service that inherits, and every alert with no service
idinteger<int64>requiredkindstringrequiredAllowed:
webhookslackmsteamsemailminSeveritystringrequiredLowest severity delivered here
Allowed:
warningcriticalnamestringrequiredThe operator's label for the destination
usedByAlertServiceRef[]requiredServices that assign this destination
Show propertiesHide properties
Array of
AlertServiceRefserviceIdstringrequiredserviceNamestringrequireddefault
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message