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.
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.
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.
Success
Unauthorized
Error
- curl
- 200
- 401
- default
Environment API Key
{- "id": "FL_xMM5LapLC",
- "type": "configuration",
- "api_key_access": {
- "events": true,
- "markers": true,
- "triggers": false,
- "boards": false,
- "queries": false,
- "columns": false,
- "createDatasets": true,
- "slos": false,
- "recipients": false,
- "privateBoards": false
}, - "environment": {
- "name": "Production",
- "slug": "production"
}, - "team": {
- "name": "Honeycomb Docs",
- "slug": "honeycomb-docs"
}
}List Authorizations V2
Returns metadata about the Management API Key used to call the API.
Success
Unauthorized
- curl
- 200
- 401
{- "included": [
- {
- "id": "hcxtm_12345678901234567890123456",
- "type": "teams",
- "attributes": {
- "name": "My Team",
- "slug": "my-team"
}
}
], - "data": {
- "id": "hcxik_12345678901234567890123456",
- "type": "api-keys",
- "relationships": {
- "team": {
- "data": {
- "id": "hxctm_12345678901234567890123456",
- "type": "teams"
}
}
}, - "attributes": {
- "name": "mgmt write key",
- "key_type": "management",
- "disabled": false,
- "scopes": [
- "api-keys:write"
], - "timestamps": {
- "created": "2022-09-22T17:32:11Z",
- "updated": "2022-10-31T15:08:11Z"
}
}
}
}