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 Key Management API

Manage API keys for a team, including listing, creating, updating, and deleting keys.

honeycomb Key Management 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 Key Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 10 operations across 4 paths, and defines 24 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 24 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 Key Management 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.

Key Management 10

Manage API keys for a team, including listing, creating, updating, and deleting keys.

GET
/1/api_keys
List all API keys
listApiKeys → 200401
POST
/1/api_keys
Create an API key
createApiKey body → 201401
GET
/1/api_keys/{keyId}
Get an API key
getApiKey 1 param → 200401404
PUT
/1/api_keys/{keyId}
Update an API key
updateApiKey 1 param body → 200401404
DELETE
/1/api_keys/{keyId}
Delete an API key
deleteApiKey 1 param → 204401404
GET
/2/teams/{teamSlug}/api-keys
List all API Keys
get2TeamsByTeamSlugApiKeys 4 params → 200401403404422429500
POST
/2/teams/{teamSlug}/api-keys
Create an API Key
post2TeamsByTeamSlugApiKeys 1 param body → 201400401403404413415422
GET
/2/teams/{teamSlug}/api-keys/{ID}
Get an API Key
get2TeamsByTeamSlugApiKeysByID 2 params → 200400401404429500
PATCH
/2/teams/{teamSlug}/api-keys/{ID}
Update an API Key
patch2TeamsByTeamSlugApiKeysByID 2 params body → 200400401403404413415422
DELETE
/2/teams/{teamSlug}/api-keys/{ID}
Delete an API Key
delete2TeamsByTeamSlugApiKeysByID 2 params → 204400401403404429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ApiKey (8 properties), DetailedError (6 properties), ApiKeyObject (5 properties), ConfigurationKeyAttributes (5 properties). Each schema is shown below with its type and property counts.

ApiKey
object
8 properties
ApiKeyCreateRequest
object
4 properties 2 required
ApiKeyUpdateRequest
object
3 properties
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
ApiKeyAttributes
object
ApiKeyObject
object
5 properties
Error
object
A legacy error, containing only a textual description.
1 property
IngestKeyType
object
1 property 1 required
ApiKeyListResponse
object
2 properties 1 required
ApiKeyUpdateRequest_2
object
1 property 1 required
ApiKeyCreateResponse
object
1 property 1 required
ConfigurationKeyRequest
object
3 properties 3 required
UserRelationship
object
1 property 1 required
CreatorRelationship
The User who initially created this resource.
ApiKeyResponse
object
1 property 1 required
IngestKeyRequest
object
3 properties 3 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
ValidationError
ApiKeyCreateRequest_2
object
1 property 1 required
PaginationLinks
object
Links to iterate through the pages of results.
1 property 1 required
IngestKeyAttributes
EnvironmentRelationship
object
The Environment this object is associated with.
1 property 1 required
EditorRelationship
The User who last edited this resource.
ConfigurationKeyAttributes
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-key-management-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 Environments API
honeycomb Auth API
honeycomb Burn Alerts API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API
Where this information came from

This is an independent, third-party profile of honeycomb Key Management 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.