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

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.

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 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.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.honeycomb.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

honeycomb Key Management 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.

Key Management 5

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

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ApiKey (8 properties), ApiKeyCreateRequest (4 properties), ApiKeyUpdateRequest (3 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

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 SLOs 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