v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
Burn Alerts

Update a Burn Alert

Update a Burn Alert by specifying its ID and full details.

put/1/burn_alerts/{datasetSlug}/{burnAlertId}

Request body

OR

Example request

{
  "alert_type": "exhaustion_time",
  "id": "fS7vfB81Wcy",
  "description": "Use this runbook if this alert fires.",
  "created_at": "2022-09-22T17:32:11Z",
  "updated_at": "2022-10-31T15:08:11Z",
  "exhaustion_minutes": 120,
  "recipients": [
    {
      "id": "abcd123",
      "type": "email",
      "target": "alerts@example.com"
    }
  ]
}

Response

Success

OR

Example response

{
  "alert_type": "exhaustion_time",
  "id": "fS7vfB81Wcy",
  "description": "Use this runbook if this alert fires.",
  "created_at": "2022-09-22T17:32:11Z",
  "updated_at": "2022-10-31T15:08:11Z",
  "exhaustion_minutes": 120,
  "slo": {
    "id": "2LBq9LckbcA"
  },
  "recipients": [
    {
      "id": "abcd123",
      "type": "email",
      "target": "alerts@example.com"
    }
  ]
}