Sign in

v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
Alerts

Create an alert

Creates a threshold alert in a project. The alert's query is validated against the Reporting API metric catalogue and the evaluation schedule starts immediately when enabled is true. Plan limits apply to the number of alerts and the minimum evaluation interval.

post/v2/alerts

Request body

display_namestring required

Workspace-unique display name.

descriptionstring

Short human-readable summary of what the alert watches.

project_idstring required

Project that owns the alert. Required.

signalstring

UI signal preset the alert is created from. Defaults to custom.

notifier_idsstring[]

Notifiers that receive trigger-open and trigger-resolve notifications.

enabledboolean

Whether the alert starts evaluating immediately. Defaults to true.

Response

OK