Update alert policy

patch

https://api.controlup.com/synthetic-monitoring/v2/scouts/{scoutId}/alerts/{alertId}

Updates an existing alert policy for a specific Scout. Any object not passed is unchanged.

📘
Updated URL and authentication
On February 11, we updated the Synthetic Monitoring API to align its URL and authentication with the rest of the ControlUp platform. Learn more.

Path Params

scoutId

integer

required

ID of the Scout.

alertId

integer

required

ID of the Scout's alert policy. Currently, each Scout supports only a single alert policy.
You can use GET /scouts/{scoutId}/alerts to get the ID of a Scout's alert policy.

Body Params

Configuration options include: disabled, conditions, trigger settings, and notifications.
At least one of these options must be included in the request.

Request schema for updating an alert for a Scout

disabled

boolean

Indicates whether the alert is enabled or disabled.

conditions

Defines the test results that trigger an alert. Select your Scout type to see how to create conditions for that Scout type.

settings

object

Settings that control when and how alerts are triggered.

notifications

array of objects

Notification configuration.

notifications

Responses

200Alert was updated successfully

400Validation error

401Unauthorized

404Resource not found

500Server error