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 Dataset Definitions API

Dataset definitions describe the fields with special meaning in the Dataset.Refer to the [Dataset Definitions](https://docs.honeycomb.io/configure/datasets/definitions/) documentation for more information.**Honeycomb automatically creates these Dataset definition fields when the Dataset is created.**Manual creation of Dataset definitions is **not** needed.## 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 Dataset Definitions API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 1 path, 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.

2 operations 1 paths 5 schemas 1 GET1 PATCH

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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Dataset Definitions 2

Dataset definitions describe the fields with special meaning in the Dataset. Refer to the [Dataset Definitions](https://docs.honeycomb.io/configure/datasets/definitions/) document…

PATCH
/1/dataset_definitions/{datasetSlug}
Set or Update Dataset Definitions
patchDatasetDefinitions 1 param body → 200400401404422
GET
/1/dataset_definitions/{datasetSlug}
Get all Dataset Definitions
listDatasetDefinitions 1 param → 200401404

Schemas 5

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

DatasetDefinitions
object
Dataset Definitions describe the fields with special meaning in the Dataset.
16 properties
DatasetDefinition
nullobject
2 properties 1 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-dataset-definitions-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 Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API