---
title: "Get a Burn Alert"
method: GET
path: "/1/burn_alerts/{datasetSlug}/{burnAlertId}"
tags: ["Burn Alerts"]
---

# Get a Burn Alert

`GET /1/burn_alerts/{datasetSlug}/{burnAlertId}`

Get a single Burn Alert by ID.

## Response `200`

Success

- union
  - object
    - `alert_type` 'exhaustion_time' | 'budget_rate', required — One of the supported alert types: 1. `exhaustion_time`: Notifies when you are about to run out of SLO budget within a specified number of hours. 1. `budget_rate`: Notifies when budget drops by at least a specified percentage within a defined time window.
    - `id` string — Unique identifier (ID) of a Burn alert.
    - `description` string — A description of the Burn Alert.
    - `triggered` boolean — Indicates if the Burn Alert has been triggered. This field is read-only and is set to `true` when the alert is triggered.
    - `created_at` string, date-time — The ISO8601-formatted time when the Burn Alert was created.
    - `updated_at` string, date-time — The ISO8601-formatted time when the Burn Alert was updated.
    - `auto_investigate` boolean — When true, Honeycomb will automatically start an investigation when this Burn Alert fires.
    - `exhaustion_minutes` integer, required — 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.
    - `slo` object — Details about the SLO associated with the burn alert.
      - `id` string — Unique identifier (ID) of a SLO.
    - `recipients` NotificationRecipient[] — A list of [Recipients](/api/recipients/) to notify when an alert fires. Using `type`+`target` is deprecated. First, create the Recipient via the Recipients API, and then specify the ID.
      - `id` string
      - `type` 'pagerduty' | 'email' | 'slack' | 'webhook' | 'msteams' | 'msteams_workflow' — One of the supported Recipient Types
      - `target` string — The target of the notification. For example, the specific Slack channel or email address. For Recipients of `type = "webhook"` or `type = "msteams_workflow"`, this will be the Name in the UI and `webhook_name` in the Recipients API. Deprecated: Use the Recipients API first, then pass the Recipient ID.
      - `details` NotificationRecipientDetails
        - `pagerduty_severity` 'critical' | 'error' | 'warning' | 'info' — When using a Recipient of `type = "pagerduty"`, the severity of the alert can be specified.
        - `variables` object[] — When using a Recipient of `type = "webhook"`, the alert-level variables can be specified.
          - `name` string, required
          - `value` string
  - object
    - `alert_type` 'exhaustion_time' | 'budget_rate', required — One of the supported alert types: 1. `exhaustion_time`: Notifies when you are about to run out of SLO budget within a specified number of hours. 1. `budget_rate`: Notifies when budget drops by at least a specified percentage within a defined time window.
    - `id` string — Unique identifier (ID) of a Burn alert.
    - `description` string — A description of the Burn Alert.
    - `triggered` boolean — Indicates if the Burn Alert has been triggered. This field is read-only and is set to `true` when the alert is triggered.
    - `created_at` string, date-time — The ISO8601-formatted time when the Burn Alert was created.
    - `updated_at` string, date-time — The ISO8601-formatted time when the Burn Alert was updated.
    - `auto_investigate` boolean — When true, Honeycomb will automatically start an investigation when this Burn Alert fires.
    - `budget_rate_window_minutes` integer, required — Required when `alert_type` is `budget_rate`. Must not be specified when `alert_type` is `exhaustion_time`. Time period (in minutes) over which a budget rate will be calculated. Must be no greater than the associated SLO's time period.
    - `budget_rate_decrease_threshold_per_million` integer, required — Required when `alert_type` is `budget_rate`. Must not be specified when `alert_type` is `exhaustion_time`. The percent the budget has decreased over the budget rate window, represented as a value out of one million. The alert will fire when this budget decrease threshold is reached. See the table below for some example conversions from desired budget decrease percent to the representation as a value out of one million | Desired percent | Value per million | |-----------------|-------------------| | 0.001% | 1 | | 1% | 10,000 | | 5% | 50,000 | | 99.99% | 999,900 |
    - `slo` object — Details about the SLO associated with the burn alert.
      - `id` string — Unique identifier (ID) of a SLO.
    - `recipients` NotificationRecipient[] — A list of [Recipients](/api/recipients/) to notify when an alert fires. Using `type`+`target` is deprecated. First, create the Recipient via the Recipients API, and then specify the ID.
      - `id` string
      - `type` 'pagerduty' | 'email' | 'slack' | 'webhook' | 'msteams' | 'msteams_workflow' — One of the supported Recipient Types
      - `target` string — The target of the notification. For example, the specific Slack channel or email address. For Recipients of `type = "webhook"` or `type = "msteams_workflow"`, this will be the Name in the UI and `webhook_name` in the Recipients API. Deprecated: Use the Recipients API first, then pass the Recipient ID.
      - `details` NotificationRecipientDetails
        - `pagerduty_severity` 'critical' | 'error' | 'warning' | 'info' — When using a Recipient of `type = "pagerduty"`, the severity of the alert can be specified.
        - `variables` object[] — When using a Recipient of `type = "webhook"`, the alert-level variables can be specified.
          - `name` string, required
          - `value` string

## Other responses

- `403` — Forbidden
- `404` — Not Found
- `422` — Validation Failed
- `429` — Rate Limit Exceeded
- `default` — Error

---

[API](https://skmtc.net/honeycomb/apis/honeycomb-api.md) · [All operations](https://skmtc.net/honeycomb/apis/honeycomb-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/honeycomb/honeycomb-api/revisions/117619fac2a5/schema)