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

The Honeycomb Datasets API provides management capabilities for datasets, which represent collections of related events from the same source. It allows developers to list, create, and update datasets programmatically. The related Columns API enables management of fields within datasets, including listing, creating, updating, and deleting columns that define the structure of event data stored in Honeycomb.

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

Tagged areas include Data Management, Datasets, 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 2 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 Datasets 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 — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Datasets 4

Manage datasets, which represent collections of related events from the same source.

GET
/1/datasets
List all datasets
listDatasets → 200401
POST
/1/datasets
Create a dataset
createDataset body → 201200401
GET
/1/datasets/{datasetSlug}
Get a dataset
getDataset 1 param → 200401404
PUT
/1/datasets/{datasetSlug}
Update a dataset
updateDataset 1 param body → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Dataset (6 properties), DatasetUpdateRequest (2 properties), DatasetCreateRequest (2 properties). Each schema is shown below with its type and property counts.

DatasetCreateRequest
object
2 properties 1 required
Dataset
object
6 properties
DatasetUpdateRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-datasets-api-openapi.yml Raw ↑

Other APIs honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb SLOs API
Honeycomb Boards API
Honeycomb Markers 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