This feature is available as part of the Honeycomb Pro and Enterprise plans.
Burn Alerts notify you when issues impact your SLO budget. Learn more about Burn Alerts here.
This API allows you to list, create, update, and delete burn alerts.
The API key must have the Manage SLOs permission. Learn more about API keys here.
Create a Burn Alert in a specified dataset against a specified SLO.
alert_type | string Default: "exhaustion_time" One of the supported alert types:
|
exhaustion_minutes required | integer >= 0 Required when Must not be specified when Amount of time (in minutes) left until your projected SLO budget is exhausted. The alert will fire when this exhaustion threshold is reached. |
required | object Details about the SLO associated with the burn alert. |
required | Array of objects (NotificationRecipient) non-empty A list of Recipients to notify when an alert fires. Using |
Created
Not Found
Validation Failed
Error
{- "alert_type": "exhaustion_time",
- "exhaustion_minutes": 120,
- "slo": {
- "id": "2LBq9LckbcA"
}, - "recipients": [
- {
- "id": "abcd123",
- "type": "email",
- "target": "alerts@example.com"
}
]
}
{- "id": "fS7vfB81Wcy",
- "created_at": "2022-09-22T17:32:11Z",
- "updated_at": "2022-10-31T15:08:11Z",
- "alert_type": "exhaustion_time",
- "exhaustion_minutes": 120,
- "slo": {
- "id": "2LBq9LckbcA"
}, - "recipients": [
- {
- "id": "abcd123",
- "type": "email",
- "target": "alerts@example.com"
}
]
}
Get all burn alerts associated with the SLO specified in the slo_id
query param. It is not currently possible to retrieve all burn alerts for a dataset, environment, or team.
Success
Not Found
Error
[- {
- "id": "fS7vfB81Wcy",
- "alert_type": "exhaustion_time",
- "exhaustion_minutes": 120,
- "slo": {
- "id": "2LBq9LckbcA"
}, - "recipients": [
- {
- "type": "slack",
- "target": "slack-alerts",
- "id": "abc123"
}
], - "created_at": "2022-09-22T17:32:11Z",
- "updated_at": "2022-10-22T17:32:11Z"
}, - {
- "id": "gT7wgC82Xcz",
- "alert_type": "budget_rate",
- "budget_rate_window_minutes": 60,
- "budget_rate_decrease_threshold_per_million": 1000,
- "slo": {
- "id": "2LBq9LckbcA"
}, - "recipients": [
- {
- "type": "slack",
- "target": "slack-alerts",
- "id": "abc123"
}
], - "created_at": "2022-09-22T17:32:11Z",
- "updated_at": "2022-10-22T17:32:11Z"
}
]
Get a single Burn Alert by ID.
Success
Not Found
Error
{- "id": "fS7vfB81Wcy",
- "created_at": "2022-09-22T17:32:11Z",
- "updated_at": "2022-10-31T15:08:11Z",
- "alert_type": "exhaustion_time",
- "exhaustion_minutes": 120,
- "slo": {
- "id": "2LBq9LckbcA"
}, - "recipients": [
- {
- "id": "abcd123",
- "type": "email",
- "target": "alerts@example.com"
}
]
}
Update a Burn Alert by specifying its ID and full details.
alert_type | string Default: "exhaustion_time" One of the supported alert types:
|
exhaustion_minutes required | integer >= 0 Required when Must not be specified when Amount of time (in minutes) left until your projected SLO budget is exhausted. The alert will fire when this exhaustion threshold is reached. |
required | Array of objects (NotificationRecipient) non-empty A list of Recipients to notify when an alert fires. Using |
Success
Not Found
Validation Failed
Error
{- "alert_type": "exhaustion_time",
- "exhaustion_minutes": 120,
- "recipients": [
- {
- "id": "abcd123",
- "type": "email",
- "target": "alerts@example.com"
}
]
}
{- "id": "fS7vfB81Wcy",
- "created_at": "2022-09-22T17:32:11Z",
- "updated_at": "2022-10-31T15:08:11Z",
- "alert_type": "exhaustion_time",
- "exhaustion_minutes": 120,
- "slo": {
- "id": "2LBq9LckbcA"
}, - "recipients": [
- {
- "id": "abcd123",
- "type": "email",
- "target": "alerts@example.com"
}
]
}