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

Markers indicate points in time on graphs where interesting things happen, such as deploys or outages.This API allows you to list, create, update, and delete Markers.## AuthorizationThe API key must have the **Manage Markers** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

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

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

This API exposes 4 operations across 2 paths, and defines 4 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.

4 operations 2 paths 4 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.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

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

Markers indicate points in time on graphs where interesting things happen, such as deploys or outages. This API allows you to list, create, update, and delete Markers. Authorizati…

POST
/1/markers/{datasetSlug}
Create a Marker
createMarker 1 param body → 201401404429default
GET
/1/markers/{datasetSlug}
List All Markers
getMarker 1 param → 200401429default
PUT
/1/markers/{datasetSlug}/{markerId}
Update a Marker
updateMarker 2 params body → 200401404429default
DELETE
/1/markers/{datasetSlug}/{markerId}
Delete a Marker
deleteMarker 2 params → 200401404429default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Marker (9 properties), DetailedError (6 properties), Error (1 property), JSONAPIError (1 property). Each schema is shown below with its type and property counts.

DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
Error
object
A legacy error, containing only a textual description.
1 property
Marker
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-markers-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Burn Alerts 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