Alerts

Update alert rule

Changes the threshold, the channels or the enabled state. Alerts already fired are left as they are.

put/api/v1/projects/{projectId}/alerts/rules/{ruleId}

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/projects/{projectId}/alerts/rules/{ruleId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

projectIdstring uuid required
ruleIdstring uuid required

Request body

namestring required
descriptionstring
alertTypestring required

The id of a condition listed by GET /api/v1/alert-conditions

severity'INFO' | 'WARNING' | 'CRITICAL'
channelstring

The id of a channel listed by GET /api/v1/alert-channels; IN_APP when left out

channelConfigobject

Settings named by the channel's configSchema. On update a setting left out is kept; a blank one clears it, except a secret, which is kept so an edit need not re-enter it.

thresholdValuenumber double

Required when the condition's configSchema lists it

windowMinutesinteger
endpointIdstring uuid
enabledboolean
mutedboolean
snoozedUntilstring date-time

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.