How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

This API exposes 3 JSON Schema definitions.

Tagged areas include Administration, Environment, and Observability. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 3 JSON Schemas.

This API exposes 10 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

10 operations 4 paths 14 schemas 2 DELETE4 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.honeycomb.io
Authentication
API Key, API Key, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 5

Honeycomb Environments API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth). An API key is passed in the header as X-Honeycomb-Team (configuration_key). An API key is passed in the header as X-Honeycomb-Team (ingest_key). An API key is passed in the header as X-Amz-Firehose-Access-Key (firehose_access_key). It accepts HTTP bearer tokens (HONEYCOMB_KEY_ID:HONEYCOMB_KEY_SECRET) (bearerAuth).

  • ApiKeyAuth — Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.
  • configuration_key — Authenticate using a Honeycomb Configuration Key. Pass the Token in the X-Honeycomb-Team header: http X-Honeycomb-Team: 1234567890123456789012 If you created y…
  • ingest_key — Authenticate using a Honeycomb Ingest Key. Pass the Ingest Key in the X-Honeycomb-Team header: http X-Honeycomb-Team: hc[x]ik1234567890123456789012345612345678…
  • firehose_access_key — We recommend using a Honeycomb Ingest Key to authenticate, though a Configuration Key will work. To learn more about authenticating requests, visit [API Authen…
  • bearerAuth — Authenticate using a Honeycomb Management Key. Pass the Management Key as a Bearer token in the Authorization header: http Authorization: Bearer hcxmk123456789…

Paths & Operations 10

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

Environments 10

Manage environments within a Honeycomb team for separating telemetry data across stages.

GET
/1/environments
List all environments
listEnvironments → 200401
POST
/1/environments
Create an environment
createEnvironment body → 201401
GET
/1/environments/{environmentId}
Get an environment
getEnvironment 1 param → 200401404
PUT
/1/environments/{environmentId}
Update an environment
updateEnvironment 1 param body → 200401404
DELETE
/1/environments/{environmentId}
Delete an environment
deleteEnvironment 1 param → 204401404
GET
/2/teams/{teamSlug}/environments
List all Environments
get2TeamsByTeamSlugEnvironments 3 params → 200401403404422429500
POST
/2/teams/{teamSlug}/environments
Create an Environment
post2TeamsByTeamSlugEnvironments 1 param body → 201400401403404409413415
GET
/2/teams/{teamSlug}/environments/{ID}
Get an Environment
get2TeamsByTeamSlugEnvironmentsByID 2 params → 200400401404429500
PATCH
/2/teams/{teamSlug}/environments/{ID}
Update an Environment
patch2TeamsByTeamSlugEnvironmentsByID 2 params body → 200400401403404413415422
DELETE
/2/teams/{teamSlug}/environments/{ID}
Delete an Environment
delete2TeamsByTeamSlugEnvironmentsByID 2 params → 204400401403404409429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Environment (7 properties), DetailedError (6 properties), Environment_2 (4 properties), EnvironmentCreateRequest (3 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-environments-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb Datasets API
Honeycomb Boards API
Honeycomb Markers API
Honeycomb Triggers API
honeycomb Auth API
honeycomb Burn Alerts API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API
honeycomb Key Management API
Where this information came from

This is an independent, third-party profile of Honeycomb Environments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.