Skip to main content
This page is a temporary reference while per-endpoint permission requirements are added to the individual endpoint pages. It will be removed once that work is complete.
Each Honeycomb API endpoint requires a specific key type and permission or scope. Use this page to confirm what your key needs before making a request. For help choosing a key type or setting up authentication, see Authentication.

Configuration Key Permissions

These endpoints require a Configuration Key passed in the X-Honeycomb-Team header. Each endpoint group requires a specific permission assigned to the key.
Endpoint GroupRequired PermissionNotes
Auth (V1)Any valid Ingest or Configuration KeyNo specific permission required.
Boards and Board ViewsManage Public Boards
Burn AlertsManage SLOs
Calculated FieldsManage Queries and Columns
ColumnsManage Queries and Columns
Dataset DefinitionsCreate Datasets
DatasetsCreate Datasets
EventsSend EventsIngest Key recommended. Configuration Key with Send Events permission also works.
Kinesis EventsSend EventsIngest Key recommended. Configuration Key with Send Events permission also works.
Markers and Marker SettingsManage Markers
QueriesManage Queries and Columns
Query AnnotationsManage Queries and Columns
Query DataManage Queries and Columns, Run QueriesBoth permissions required.
RecipientsManage RecipientsRecipients are team-wide, not Environment-specific. A key with this permission can modify recipients across all Environments in your Team.
ReportingManage SLOs
Service MapsRead Service Maps
SLOsManage SLOs
TriggersManage Triggers

Management Key Scopes

These endpoints require a Management Key passed as a Bearer token in the Authorization header. Each endpoint requires a specific scope assigned to the key.
Endpoint GroupRequired ScopeNotes
Auth (V2)Any valid Management Key
Environmentsenvironments:read (read operations), environments:write (create, update, delete)
Key Managementapi-keys:read (read operations), api-keys:write (create, update, delete)Supports both Ingest Keys and Config Keys.