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 Query Annotations API

Query Annotations in Honeycomb allow you to associate names and descriptions to queries to add additional information in collaboration features.This API allows you to list, create, update, and delete Query Annotations.## AuthorizationThe API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

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

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

This API exposes 5 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.

5 operations 2 paths 4 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.

Query Annotations 5

Query Annotations in Honeycomb allow you to associate names and descriptions to queries to add additional information in collaboration features. This API allows you to list, creat…

POST
/1/query_annotations/{datasetSlug}
Create a Query Annotation
createQueryAnnotation 1 param body → 201400403404429default
GET
/1/query_annotations/{datasetSlug}
List Query Annotations
listQueryAnnotations 2 params → 200404429default
GET
/1/query_annotations/{datasetSlug}/{queryAnnotationId}
Get a Query Annotation
getQueryAnnotation 2 params → 200404429default
PUT
/1/query_annotations/{datasetSlug}/{queryAnnotationId}
Update a Query Annotation
updateQueryAnnotation 2 params body → 200400404429default
DELETE
/1/query_annotations/{datasetSlug}/{queryAnnotationId}
Delete a Query Annotation
deleteQueryAnnotation 2 params → 204404429default

Schemas 4

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

QueryAnnotation
object
A Query Annotation consists of a name and description associated with a query to add context when collaborating.
7 properties 2 required
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-query-annotations-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