Honeycomb API (1.0.0)

Download OpenAPI specification:Download

The API allows programmatic management of many resources within Honeycomb.

Please report any discrepancies with actual API behavior in Pollinators Slack or to Honeycomb Support.

Auth

API Keys have various scopes permissions and belong to a specific Team or Environment.

Any valid Honeycomb API Key will work with this endpoint. Learn more about API keys.

These endpoints can be used to validate authentication for a key, to determine what authorizations have been granted to a key, and to determine the Team and Environment that a key belongs to.

List Authorizations

Returns metadata about the API Key used to call the API.

Note: a Honeycomb Classic API key will return an empty string for both of the environment values.

Securityconfiguration_key or ingest_key
Responses
200

Success

401

Unauthorized

default

Error

get/1/auth
Request samples
Response samples
application/json

Environment API Key

{
  • "id": "FL_xMM5LapLC",
  • "type": "configuration",
  • "api_key_access": {
    },
  • "environment": {
    },
  • "team": {
    }
}

List Authorizations V2 [Beta]

Returns metadata about the Management API Key used to call the API.

SecuritybearerAuth
Responses
200

Success

401

Unauthorized

get/2/auth
Request samples
Response samples
application/vnd.api+json
{
  • "included": [
    ],
  • "data": {
    }
}