Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb Burn Alerts API

This feature is available as part of the [Honeycomb Pro and Enterprise plans](https://www.honeycomb.io/pricing/).Burn Alerts notify you when issues impact your SLO budget. Learn more about [Burn Alerts here](https://docs.honeycomb.io/notify/alert/slos/monitor/).This API allows you to list, create, update, and delete burn alerts.## AuthorizationThe API key must have the **Manage SLOs** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

Honeycomb Burn Alerts API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Burn Alerts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

5 operations 2 paths 22 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Burn Alerts 5

This feature is available as part of the [Honeycomb Pro and Enterprise plans](https://www.honeycomb.io/pricing/). Burn Alerts notify you when issues impact your SLO budget. Learn…

POST
/1/burn_alerts/{datasetSlug}
Create a Burn Alert
createBurnAlert 1 param body → 201403404422429default
GET
/1/burn_alerts/{datasetSlug}
List All Burn Alerts for an SLO
listBurnAlertsBySlo 2 params → 200403404422429default
GET
/1/burn_alerts/{datasetSlug}/{burnAlertId}
Get a Burn Alert
getBurnAlert 2 params → 200403404422429default
PUT
/1/burn_alerts/{datasetSlug}/{burnAlertId}
Update a Burn Alert
updateBurnAlert 2 params body → 200403404422429default
DELETE
/1/burn_alerts/{datasetSlug}/{burnAlertId}
Delete a Burn Alert
deleteBurnAlert 2 params → 204403404429default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are BurnAlertSharedParams (6 properties), DetailedError (6 properties), NotificationRecipient (4 properties), NotificationRecipientDetails (2 properties). Each schema is shown below with its type and property counts.

RecipientType
string
One of the supported Recipient Types
ExhaustionTimeBurnAlertDetailResponse
BurnAlertDetailResponse
object
1 property 1 required
UpdateBurnAlertRequest
object
1 property 1 required
ExhaustionTimeBurnAlert
CreateBudgetRateBurnAlertRequest
BudgetRateBurnAlertDetailResponse
BudgetRateBurnAlertListResponse
BudgetRateBurnAlert
CreateExhaustionTimeBurnAlertRequest
Error
object
A legacy error, containing only a textual description.
1 property
ValidationError
NotificationRecipientDetails
object
2 properties
UpdateExhaustionTimeBurnAlertRequest
BurnAlertSharedParams
object
6 properties
NotificationRecipient
object
4 properties
BurnAlertListResponse
object
1 property 1 required
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
ExhaustionTimeBurnAlertListResponse
UpdateBudgetRateBurnAlertRequest
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
CreateBurnAlertRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-burn-alerts-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Calculated Fields API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API