Skip to main content
PATCH
Pause or resume an alert

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

alert_id
string
required

Body

application/json

Body for pausing or resuming an alert.

Only ACTIVE and PAUSED are settable: PARKED is the evaluator's verdict.

project_id
string
required
status
enum<string>
required
Available options:
ACTIVE,
PAUSED

Response

Successful Response

The updated alert with its full rule, plus what the edit did to its state.

alert
AlertDetail · object
required

One alert with its full rule: the summary plus filters and gap handling.

changed
string[]
required
updated
boolean
required
page_cleared
boolean
default:false

True when the alert was firing and the edit discarded that page

state_reset
boolean
default:false

True when the edit voided the evaluation state and made the rule due now (any evaluated field changed, or the alert was resumed)