PYpydantic
Projects
Alerts

Create Alert

Create a new alert.

post/v1/projects/{project_id}/alerts/

Request

Path parameters

project_idstring uuid required

Request body

namestring required
descriptionstring
querystring required
time_windowstring duration required
frequencystring duration required
watermarkstring duration required
activeboolean

Whether the alert starts enabled.

channel_idsstring[] nullable

Legacy shorthand for assigning channels without schedules.

notify_when'has_matches' | 'has_matches_changed' | 'matches_changed' | 'starts_having_matches' required
environmentsstring[]

Deployment environments to scope the query to. Empty = all environments (no filter).

Example request

{
  "query": "SELECT 1"
}

Response

Successful Response

idstring uuid required
organization_idstring uuid required
project_idstring uuid required
created_atstring date-time required
updated_atstring date-time nullable required
created_by_namestring nullable required
updated_by_namestring nullable required
namestring required
descriptionstring nullable required
querystring required
time_windowstring duration required
frequencystring duration required
watermarkstring duration required
environmentsstring[] required
notify_when'has_matches' | 'has_matches_changed' | 'matches_changed' | 'starts_having_matches' required
activeboolean required
slo_idstring uuid nullable
integration_idstring nullable
schedule_warningstring nullable
slo_tierinteger nullable
slo_tier_viableboolean nullable
slo_bucket_tierinteger nullable
snoozed_untilstring date-time nullable required

Changes

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