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

This API allows you to list, create, update, and delete API Keys for a Team.Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).## Authorization This API requires a Management Key passed via the HTTP Authorization header. Join the key ID andsecret with a colon, like this: `Authorization: Bearer :`.

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

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

This API exposes 5 operations across 2 paths, and defines 21 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 21 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.

Key Management 5

This API allows you to list, create, update, and delete API Keys for a Team. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). A…

GET
/2/teams/{teamSlug}/api-keys
List all API Keys
listApiKeys 4 params → 200401403404422429500
POST
/2/teams/{teamSlug}/api-keys
Create an API Key
createApiKey 1 param body → 201400401403404413415422
GET
/2/teams/{teamSlug}/api-keys/{ID}
Get an API Key
getApiKey 2 params → 200400401404429500
PATCH
/2/teams/{teamSlug}/api-keys/{ID}
Update an API Key
updateApiKey 2 params body → 200400401403404413415422
DELETE
/2/teams/{teamSlug}/api-keys/{ID}
Delete an API Key
deleteApiKey 2 params → 204400401403404429500

Schemas 21

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-key-management-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 Environments API
Honeycomb Events API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API