List All Burn Alerts for an SLO
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.
Authorizations
Authenticate using a Honeycomb Configuration Key.
Pass the Token in the X-Honeycomb-Team header:
If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.
To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.
Path Parameters
The dataset slug or use __all__ for endpoints that support environment-wide operations.
Query Parameters
For use with the list endpoint to retrieve all burn alerts for a specified SLO.
Response
Success
- Exhaustion Time
- Budget Rate
One of the supported alert types:
exhaustion_time: Notifies when you are about to run out of SLO budget within a specified number of hours.budget_rate: Notifies when budget drops by at least a specified percentage within a defined time window.
exhaustion_time, budget_rate "exhaustion_time"
Required when alert_type is exhaustion_time.
Must not be specified when alert_type is budget_rate.
Amount of time (in minutes) left until your projected SLO budget is exhausted. The alert will fire when this exhaustion threshold is reached.
x >= 0120
Unique identifier (ID) of a Burn alert.
"fS7vfB81Wcy"
A description of the Burn Alert.
1023"Use this runbook if this alert fires."
Indicates if the Burn Alert has been triggered. This field is read-only and is set to true when the alert is triggered.
false
The ISO8601-formatted time when the Burn Alert was created.
"2022-09-22T17:32:11Z"
The ISO8601-formatted time when the Burn Alert was updated.
"2022-10-31T15:08:11Z"
When true, Honeycomb will automatically start an investigation when this Burn Alert fires.
false
Details about the SLO associated with the burn alert.