How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

honeycomb Burn Alerts API

Manage burn alerts that notify you when issues impact your SLO budget.

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

This API exposes 3 JSON Schema definitions.

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

This API exposes 5 operations across 2 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

5 operations 2 paths 26 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.honeycomb.io
Authentication
API Key, API Key, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 5

honeycomb Burn Alerts API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth). An API key is passed in the header as X-Honeycomb-Team (configuration_key). An API key is passed in the header as X-Honeycomb-Team (ingest_key). An API key is passed in the header as X-Amz-Firehose-Access-Key (firehose_access_key). It accepts HTTP bearer tokens (HONEYCOMB_KEY_ID:HONEYCOMB_KEY_SECRET) (bearerAuth).

  • ApiKeyAuth — Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.
  • configuration_key — Authenticate using a Honeycomb Configuration Key. Pass the Token in the X-Honeycomb-Team header: http X-Honeycomb-Team: 1234567890123456789012 If you created y…
  • ingest_key — Authenticate using a Honeycomb Ingest Key. Pass the Ingest Key in the X-Honeycomb-Team header: http X-Honeycomb-Team: hc[x]ik1234567890123456789012345612345678…
  • firehose_access_key — We recommend using a Honeycomb Ingest Key to authenticate, though a Configuration Key will work. To learn more about authenticating requests, visit [API Authen…
  • bearerAuth — Authenticate using a Honeycomb Management Key. Pass the Management Key as a Bearer token in the Authorization header: http Authorization: Bearer hcxmk123456789…

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

Manage burn alerts that notify you when issues impact your SLO budget.

GET
/1/burn_alerts/{datasetSlug}
List all burn alerts
listBurnAlerts 2 params → 200401
POST
/1/burn_alerts/{datasetSlug}
Create a burn alert
createBurnAlert 2 params body → 201401
GET
/1/burn_alerts/{datasetSlug}/{burnAlertId}
Get a burn alert
getBurnAlert 4 params → 200401404
PUT
/1/burn_alerts/{datasetSlug}/{burnAlertId}
Update a burn alert
updateBurnAlert 4 params body → 200401404
DELETE
/1/burn_alerts/{datasetSlug}/{burnAlertId}
Delete a burn alert
deleteBurnAlert 4 params → 204401404

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are BurnAlert (9 properties), DetailedError (6 properties), BurnAlertSharedParams (6 properties), BurnAlertCreateRequest (6 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb Datasets API
Honeycomb Boards API
Honeycomb Markers API
Honeycomb Triggers API
Honeycomb Environments API
honeycomb Auth API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API
honeycomb Key Management API
Where this information came from

This is an independent, third-party profile of honeycomb Burn Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.