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 Markers API

The Honeycomb Markers API enables developers to create and manage markers that indicate points in time on graphs where notable events occurred, such as deploys, configuration changes, or outages. Marker Settings allow grouping similar markers together with consistent visual styling. The API supports listing, creating, updating, and deleting both markers and marker settings, making it straightforward to integrate deployment pipelines and incident workflows with Honeycomb visualizations.

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

Tagged areas include Annotations, Deployments, Markers, and Observability. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.honeycomb.io.

4 operations 2 paths 3 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.honeycomb.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Honeycomb Markers API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.

Paths & Operations 4

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

Markers 4

Manage markers that indicate points in time on graphs where notable events occurred such as deploys or outages.

GET
/1/markers/{datasetSlug}
List all markers
listMarkers 1 param → 200401
POST
/1/markers/{datasetSlug}
Create a marker
createMarker 1 param body → 201401
PUT
/1/markers/{datasetSlug}/{markerId}
Update a marker
updateMarker 2 params body → 200401404
DELETE
/1/markers/{datasetSlug}/{markerId}
Delete a marker
deleteMarker 2 params → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Marker (8 properties), MarkerCreateRequest (5 properties), MarkerUpdateRequest (5 properties). Each schema is shown below with its type and property counts.

MarkerUpdateRequest
object
5 properties
Marker
object
8 properties
MarkerCreateRequest
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-markers-api-openapi.yml Raw ↑

Other APIs honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb SLOs API
Honeycomb Datasets API
Honeycomb Boards API
Honeycomb Triggers API
Honeycomb Environments API
honeycomb Auth API
honeycomb Burn Alerts API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API