Create alert policy

post

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

Creates a new alert policy for a Scout. A Scout can have only one alert policy. If one already exists, you can update it or delete it. Alerts trigger when the Scout's test results meet certain conditions.

📘
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.

Body Params

Alert configuration including conditions, trigger settings, and optional notifications.

Request schema for creating a new alert for a Scout

conditions

required

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 configurations for when alerts are triggered. This field is optional.

If no notifications are configured, you can still get information about each time the alert has triggered using the alerts API endpoints.

notifications

Responses

201Alert created successfully

400Validation error

401Unauthorized

404Resource not found

500Server error