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 Marker Settings API

Marker Settings apply to groups of similar Markers.For example, "deploys" markers appear with the same color on a graph.This API allows you to list, create, update, and delete Marker Settings.## 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 Marker Settings API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Marker Settings 4

Marker Settings apply to groups of similar Markers. For example, "deploys" markers appear with the same color on a graph. This API allows you to list, create, update, and delete M…

POST
/1/marker_settings/{datasetSlug}
Create a Marker Setting
createMarkerSetting 1 param body → 201404422429
GET
/1/marker_settings/{datasetSlug}
Get a Marker Setting
listMarkerSettings 1 param → 200404429
PUT
/1/marker_settings/{datasetSlug}/{markerSettingId}
Update a Marker Setting
updateMarkerSettings 2 params body → 200404422429
DELETE
/1/marker_settings/{datasetSlug}/{markerSettingId}
Delete a Marker Setting
deleteMarkerSettings 2 params → 200404429

Schemas 5

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

MarkerSetting
object
5 properties 2 required
ValidationError
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-marker-settings-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 Markers API