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

This API allows you to list, create, and update, and delete Environments.## AuthorizationThis API requires a Management Key passed via the HTTP Authorization header. Join the key ID and secret with a colon, like this: `Authorization: Bearer :`.

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

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

This API exposes 5 operations across 2 paths, and defines 11 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 11 schemas 1 DELETE2 GET1 PATCH1 POST

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 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Environments 5

This API allows you to list, create, and update, and delete Environments. Authorization This API requires a Management Key passed via the HTTP Authorization header. Join the key I…

GET
/2/teams/{teamSlug}/environments
List all Environments
listEnvironments 3 params → 200401403404422429500
POST
/2/teams/{teamSlug}/environments
Create an Environment
createEnvironment 1 param body → 201400401403404409413415
GET
/2/teams/{teamSlug}/environments/{ID}
Get an Environment
getEnvironment 2 params → 200400401404429500
PATCH
/2/teams/{teamSlug}/environments/{ID}
Update an Environment
updateEnvironment 2 params body → 200400401403404413415422
DELETE
/2/teams/{teamSlug}/environments/{ID}
Delete an Environment
deleteEnvironment 2 params → 204400401403404409429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are DetailedError (6 properties), Environment (4 properties), EnvironmentListResponse (2 properties), PaginationLinks (1 property). Each schema is shown below with its type and property counts.

Environment
object
4 properties 4 required
PaginationLinks
object
Links to iterate through the pages of results.
1 property 1 required
EnvironmentListResponse
object
2 properties 1 required
Error
object
A legacy error, containing only a textual description.
1 property
CreateEnvironmentRequest
object
1 property 1 required
ValidationError
EnvironmentResponse
object
1 property 1 required
UpdateEnvironmentRequest
object
1 property 1 required
EnvironmentColor
string
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-environments-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 Datasets API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API