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

A Dataset represents a collection of related events that come from the same source, or are related to the same source.This API allows you to list, create, and update datasets.## AuthorizationThe API key must have the **Create Datasets** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

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

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

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

Datasets 5

A Dataset represents a collection of related events that come from the same source, or are related to the same source. This API allows you to list, create, and update datasets. Au…

POST
/1/datasets
Create a Dataset
createDataset body → 200201401403409422429default
GET
/1/datasets
List All Datasets
listDatasets → 200401429default
GET
/1/datasets/{datasetSlug}
Get a Dataset
getDataset 1 param → 200401404429default
DELETE
/1/datasets/{datasetSlug}
Delete a Dataset
deleteDataset 1 param → 202401403404409429default
PUT
/1/datasets/{datasetSlug}
Update a Dataset
updateDataset 1 param body → 200401404429

Schemas 7

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

Dataset
object
Datasets are a collection of events from a specific source or related source.
9 properties 1 required
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
ValidationError
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
DatasetUpdatePayload
object
an object to send to the Dataset API via PUT
3 properties 2 required
DatasetCreationPayload
object
an object to send to the Dataset API via PUT
3 properties 1 required
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-datasets-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 Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API