Alerts

Pause or resume an alert

Pause or resume an alert without touching its rule.

Requires MEMBER role or higher in the project's workspace (the write service decides). Pausing keeps the severity it stopped at; resuming is a cold start (state reset, due now). Setting the status the alert already has is a 200 with nothing changed.

Args: request (Request): Incoming request (rate-limit plumbing). response (Response): Outgoing response (rate-limit plumbing). auth (AccountStampedAuth): Account-scope user auth (session token or CLI access JWT); its resolved user_id becomes the actor. alert_id (str): The alert to pause or resume. payload (AlertStatusRequest): The project and the target status. _live (None): Write-path liveness gate (blocks a revoked JWT session).

Returns: UpdateAlertResponse: The alert with its new status and the state flags.

Raises: HTTPException: The write service's 400/403/404/409 verbatim, or a 503 when its response is ambiguous.

patch/api/v1/public/alerts/{alert_id}/status

Request

  • Base URL
    https://app.traceroot.ai
  • URL
    https://app.traceroot.ai/api/v1/public/alerts/{alert_id}/status
  • Auth
    HTTP bearer

Path parameters

alert_idstring required

Request body

project_idstring required
status'ACTIVE' | 'PAUSED' required

Response

Successful Response

changedstring[] required
page_clearedboolean

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

state_resetboolean

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

updatedboolean required

Changes

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