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

Manage dataset definitions that configure how columns are interpreted and displayed.

honeycomb Dataset Definitions API is one of 22 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 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.honeycomb.io.

2 operations 1 paths 1 schemas 1 GET1 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 Dataset Definitions 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 2

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

Dataset Definitions 2

Manage dataset definitions that configure how columns are interpreted and displayed.

GET
/1/dataset_definitions/{datasetSlug}
Get dataset definition
getDatasetDefinition 1 param → 200401404
PUT
/1/dataset_definitions/{datasetSlug}
Update dataset definition
updateDatasetDefinition 1 param body → 200401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is DatasetDefinition (9 properties). Each schema is shown below with its type and property counts.

DatasetDefinition
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-dataset-definitions-api-openapi.yml Raw ↑

Other APIs honeycomb publishes across the network.

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