Skip to main content
PUT
Update a Burn Alert

Authorizations

X-Honeycomb-Team
string
header
required

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

datasetSlug
string
required

The dataset slug or use __all__ for endpoints that support environment-wide operations.

burnAlertId
string
required

The unique identifier (ID) of a Burn Alert.

Body

application/json
alert_type
enum<string>
default:exhaustion_time
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.
  2. budget_rate: Notifies when budget drops by at least a specified percentage within a defined time window.
Available options:
exhaustion_time,
budget_rate
Example:

"exhaustion_time"

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.

Required range: x >= 0
Example:

120

recipients
object[]
required

A list of 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.

Minimum array length: 1
Example:
description
string

A description of the Burn Alert.

Maximum string length: 1023
Example:

"Use this runbook if this alert fires."

auto_investigate
boolean
default:false

When true, Honeycomb will automatically start an investigation when this Burn Alert fires.

Example:

false

Response

Success

alert_type
enum<string>
default:exhaustion_time
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.
  2. budget_rate: Notifies when budget drops by at least a specified percentage within a defined time window.
Available options:
exhaustion_time,
budget_rate
Example:

"exhaustion_time"

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.

Required range: x >= 0
Example:

120

id
string
read-only

Unique identifier (ID) of a Burn alert.

Example:

"fS7vfB81Wcy"

description
string

A description of the Burn Alert.

Maximum string length: 1023
Example:

"Use this runbook if this alert fires."

triggered
boolean
read-only

Indicates if the Burn Alert has been triggered. This field is read-only and is set to true when the alert is triggered.

Example:

false

created_at
string<date-time>
read-only

The ISO8601-formatted time when the Burn Alert was created.

Example:

"2022-09-22T17:32:11Z"

updated_at
string<date-time>
read-only

The ISO8601-formatted time when the Burn Alert was updated.

Example:

"2022-10-31T15:08:11Z"

auto_investigate
boolean
default:false

When true, Honeycomb will automatically start an investigation when this Burn Alert fires.

Example:

false

slo
object

Details about the SLO associated with the burn alert.

Example:
recipients
object[]

A list of 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.

Minimum array length: 1
Example: