Update Alert

Updates an existing alert

PUT /api/v2/alerts/{id}

Error

A valid request URL is required to generate request examples

200

{
  "data": {
    "dashboardId": "65f5e4a3b9e77c001a567890",
    "tileId": "65f5e4a3b9e77c001a901234",
    "savedSearchId": "65f5e4a3b9e77c001a345678",
    "groupBy": "ServiceName",
    "threshold": 100,
    "thresholdMax": 500,
    "interval": "1h",
    "scheduleOffsetMinutes": 2,
    "scheduleStartAt": "2026-02-08T10:00:00.000Z",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
      "type": "webhook",
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "name": "Test Alert",
    "message": "Test Alert Message",
    "note": "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).",
    "numConsecutiveWindows": 3,
    "id": "65f5e4a3b9e77c001a123456",
    "state": "ALERT",
    "teamId": "65f5e4a3b9e77c001a345678",
    "silenced": {
      "by": "65f5e4a3b9e77c001a234567",
      "at": "2026-03-19T08:00:00.000Z",
      "until": "2026-03-20T08:00:00.000Z"
    },
    "executionErrors": [
      {
        "timestamp": "2026-04-17T12:00:00.000Z",
        "type": "QUERY_ERROR",
        "message": "Query timed out after 30s"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

Autorizações

Authorization · string · header · obrigatório

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

Parâmetros de caminho

id · string · obrigatório

Alert ID

Corpo

application/json

threshold · number · obrigatório

Threshold value for triggering the alert. For between and not_between threshold types, this is the lower bound.

Exemplo:

100

interval · enum<string> · obrigatório

Evaluation interval for the alert.

Opções disponíveis: 1m, 5m, 15m, 30m, 1h, 6h, 12h, 1d

Exemplo:

"1h"

thresholdType · enum<string> · obrigatório

Threshold comparison direction.

Opções disponíveis: above, below, above_exclusive, below_or_equal, equal, not_equal, between, not_between

Exemplo:

"above"

channel · object · obrigatório

Alert notification channel configuration.

Show child attributes

dashboardId · string | null

Dashboard ID for tile-based alerts.

Exemplo:

"65f5e4a3b9e77c001a567890"

tileId · string | null

Tile ID for tile-based alerts. Must be a line, stacked bar, or number type tile.

Exemplo:

"65f5e4a3b9e77c001a901234"

savedSearchId · string | null

Saved search ID for saved_search alerts.

Exemplo:

"65f5e4a3b9e77c001a345678"

groupBy · string | null

Group-by key for saved search alerts.

Exemplo:

"ServiceName"

thresholdMax · number | null

Upper bound for between and not_between threshold types. Required when thresholdType is between or not_between, must be >= threshold.

Exemplo:

500

scheduleOffsetMinutes · integer | null

Offset from the interval boundary in minutes. For example, 2 with a 5m interval evaluates windows at :02, :07, :12, etc. (UTC).

Intervalo obrigatório: x >= 0

Exemplo:

2

scheduleStartAt · string<date-time> | null

Absolute UTC start time anchor. Alert windows start from this timestamp and repeat every interval.

Exemplo:

"2026-02-08T10:00:00.000Z"

source · enum<string>

Alert source type (tile-based or saved search).

Opções disponíveis: saved_search, tile

Exemplo:

"tile"

name · string | null

Human-friendly alert name.

Exemplo:

"Test Alert"

message · string | null

Alert message template.

Exemplo:

"Test Alert Message"

note · string | null

Freeform note for the alert. Supports markdown formatting.

Required string length: 1 - 4096

Exemplo:

"Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook)."

numConsecutiveWindows · integer | null

Fire the alert only after its condition has been met for this many consecutive evaluation windows. While the condition is met but fewer than this many consecutive windows have violated, the alert is in the PENDING state.

Intervalo obrigatório: x >= 1

Exemplo:

3

Resposta

200

application/json

Successfully updated alert

data · object

The alert object.

Show child attributes