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 Group | Required Permission | Notes |
|---|
| Auth (V1) | Any valid Ingest or Configuration Key | No specific permission required. |
| Boards and Board Views | Manage Public Boards | |
| Burn Alerts | Manage SLOs | |
| Calculated Fields | Manage Queries and Columns | |
| Columns | Manage Queries and Columns | |
| Dataset Definitions | Create Datasets | |
| Datasets | Create Datasets | |
| Events | Send Events | Ingest Key recommended. Configuration Key with Send Events permission also works. |
| Kinesis Events | Send Events | Ingest Key recommended. Configuration Key with Send Events permission also works. |
| Markers and Marker Settings | Manage Markers | |
| Queries | Manage Queries and Columns | |
| Query Annotations | Manage Queries and Columns | |
| Query Data | Manage Queries and Columns, Run Queries | Both permissions required. |
| Recipients | Manage Recipients | Recipients are team-wide, not Environment-specific. A key with this permission can modify recipients across all Environments in your Team. |
| Reporting | Manage SLOs | |
| Service Maps | Read Service Maps | |
| SLOs | Manage SLOs | |
| Triggers | Manage 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 Group | Required Scope | Notes |
|---|
| Auth (V2) | Any valid Management Key | |
| Environments | environments:read (read operations), environments:write (create, update, delete) | |
| Key Management | api-keys:read (read operations), api-keys:write (create, update, delete) | Supports both Ingest Keys and Config Keys. |