Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Alerts

Update Topline Alert

patch/console/v1/alerts/{id}

Path parameters

idstring required

id

Request body

namestring

Name of the alert (4-100 characters)

messagestring

Alert message shown when the alert fires

alertThresholdnumber double

Threshold value that triggers the alert

warningThresholdnumber double nullable

Optional warning threshold value. Pass null to clear.

formulastring nullable

Formula expression. Pass null to clear.

windowMsnumber double

How far back and how frequently a metric should be checked, in milliseconds. Must be between 60_000 and 30 days.

condition'greater' | 'greater_or_equal' | 'less' | 'less_or_equal' | 'equal' | 'not_equal'

Condition under which a metric change triggers an alert

priority'P1' | 'P2' | 'P3' | 'P4'

Alert priority

renotificationConditionsstring[] nullable

Conditions under which a re-notification is sent. Pass null to clear.

renotificationWindowMsnumber double

How long to wait before re-notifying, in ms

evaluationDelayMsnumber double

Delay before evaluating metrics, in milliseconds. Pass 0 to clear.

renotificationMessagestring

Re-notification message

teamIDstring nullable

ID of the team that owns this alert. Pass null to clear.

definitionMetricsJsonstring[]

JSON-encoded metric definitions evaluated by the alert. Each entry is a stringified ToplineAlertMExDefinitionOrUnresolved. When omitted, existing definitions are preserved. Pass an empty array to clear all metrics.

tagsstring[]

Tags to attach to the alert. When omitted, existing tags are preserved. Pass an empty array to clear all tags.

Example request

{
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "owner123@test.com"
  }
}

Response

Update Alert success response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "data": {
    "owner": {
      "ownerID": "user123",
      "ownerType": "USER",
      "ownerName": "John Doe",
      "ownerEmail": "owner123@test.com"
    }
  }
}