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

API Keys have various scopes permissions and belong to a specific Team or Environment.Any valid Honeycomb ingest or configuration API Key will work with this endpoint. Learn more about [API keys](https://docs.honeycomb.io/get-started/best-practices/api-keys).These endpoints can be used to validate authentication for a key, to determine what authorizations have been grantedto a key, and to determine the Team and Environment that a key belongs to.

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

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

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

2 operations 2 paths 7 schemas 2 GET

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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Auth 2

API Keys have various scopes permissions and belong to a specific Team or Environment. Any valid Honeycomb ingest or configuration API Key will work with this endpoint. Learn more…

GET
/1/auth
List Authorizations
getAuth → 200401429default
GET
/2/auth
List Authorizations V2
getV2Auth → 200401429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DetailedError (6 properties), Auth (5 properties), IncludedResource (3 properties), AuthV2Response (2 properties). Each schema is shown below with its type and property counts.

Auth
object
5 properties 5 required
TeamRelationship
object
1 property 1 required
AuthV2Response
object
2 properties 1 required
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
Error
object
A legacy error, containing only a textual description.
1 property
IncludedResource
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-auth-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

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