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

Validate authentication for a key, determine what authorizations have been granted to a key, and determine the Team and Environment it belongs to.

honeycomb Auth API is one of 22 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 2 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.

2 operations 2 paths 2 schemas 2 GET

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

Validate authentication for a key, determine what authorizations have been granted to a key, and determine the Team and Environment it belongs to.

GET
/1/auth
Authenticate API key
getAuth → 200401
GET
/1/auth/permissions
List authorizations
listAuthorizations → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are AuthInfo (2 properties), AuthPermissions (1 property). Each schema is shown below with its type and property counts.

AuthInfo
object
2 properties
AuthPermissions
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-auth-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 Burn Alerts API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API