Honeycomb Environments API
The Honeycomb Environments API provides administrative capabilities for managing environments within a Honeycomb team. Environments allow organizations to separate telemetry data across different stages such as development, staging, and production. The API supports listing, creating, updating, and deleting environments, along with the Auth API for validating API keys and determining their associated team and environment permissions.
Honeycomb Environments API is one of 22 APIs that honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Administration, Environments, and Observability. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 5 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Honeycomb Environments 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 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.
Manage environments within a Honeycomb team for separating telemetry data across stages.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Environment (7 properties), EnvironmentUpdateRequest (3 properties), EnvironmentCreateRequest (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from honeycomb 12
Other APIs honeycomb publishes across the network.