Each Environment allows you to define API Keys for use within it.
You can create and manage API Keys through the Honeycomb UI.
In Honeycomb, API keys are associated with Honeycomb Environments, which organize all of your Honeycomb resources and consist of a set of datasets, a set of API keys, a set of custom fields, and a set of markers.
When you create an API key, you assign it a set of permissions, which determines which actions your Team can use it to perform in the associated Environment.
Any programmatic request sent to Honeycomb must use an API Key.
Honeycomb uses two types of API keys, each for different purposes:
To learn more about using API Keys, visit Best Practices for API Keys.
When you join Honeycomb, we help you create your first Team and Environment. As part of this process, we create your first API Key–a Configuration Key–for you.
To find your API Keys:
Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select Manage Environments.
In the list, locate the Environment for which you would like to find API Keys, and select its name to view the available settings.
Select the API Keys view.
Select the view that corresponds to the type of API Keys that you would like to view, either Ingest or Configuration.
To create your API Key:
Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select Manage Environments.
In the list, locate the Environment to which you would like to add an API Key, and select its name to view the available settings.
Select the API Keys view.
Select the view that corresponds to the type of API Key that you would like to create, either Ingest or Configuration.
Select Create API Key.
In the Create API Key modal, enter a Name for the API Key, and select the actions you would like the API Key to be able to perform.
To learn more about the actions that you can assign to API Keys, visit the API Key permissions section.
If you are creating a Configuration API Key, also select whether you would like the API Key to be visible to Team owners only or to all Team members.
Select Save.
Copy your API Key and save it to a secure location. For security reasons, you will not be able to see the key again.
Select Ok, I’ve copied the key
Your new API Key should now show in the list of keys.
To change your API Key:
Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select Manage Environments.
In the list, locate the Environment that contains the API Key that you want to edit, and select its name to view the available settings.
Select the API Keys view.
Select the view that corresponds to the type of API Key that you would like to change, either Ingest or Configuration.
In the list, locate the API Key that you want to change, and select Details to view its settings.
Change the API Key’s details as desired. To learn more about the actions that you can assign to API Keys, visit the API Key permissions section.
Select Save.
Your API Key will be changed, but it may take several minutes for the changes to go into effect.
Deleting an Ingest Key is permanent, so make sure you really want to delete your Ingest Key before doing so.
To delete an Ingest Key, you must be a Team Owner.
To delete your Ingest Key:
Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select Manage Environments.
In the list, locate the Environment that contains the API Key that you want to delete, and select its name to view the available settings.
Select the API Keys view.
Select the Ingest Keys view.
In the list, locate the Ingest Key that you want to delete, and select Details to view its settings.
Select Delete.
In the Delete Ingest API Key? modal, enter the unique identifier of the Ingest Key (located above the field).
Select Delete.
Your Ingest Key will no longer show in the list, but it may take several minutes for the process to complete.
To disable your Configuration Key:
Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select Manage Environments.
In the list, locate the Environment that contains the API Key that you want to disable, and select its name to view the available settings.
Select the API Keys view.
Select the Configuration Keys view.
In the list, locate the Configuration Key that you want to disable, and select Details to view its settings.
Locate the Enable checkbox, and deselect it.
Select Save.
Your Configuration Key will no longer show in the list, but it may take several minutes for the process to complete.
To enable your Configuration Key:
Log in to the Honeycomb UI.
Select the Environments label on the top-left, then select Manage Environments.
In the list, locate the Environment that contains the API Key that you want to enable, and select its name to view the available settings.
Select the API Keys view.
Select the Configuration Keys view.
Select Show disabled keys.
In the list, locate the Configuration Key that you want to enable, and select Details to view its settings.
Locate the Enable checkbox, and select it.
Select Save.
Your Configuration Key will show in the list of Configuration Keys, but it may take several minutes for the process to complete.
Honeycomb uses two types of API keys, each for different purposes:
However, you can manage the actions that API Keys may perform in your Environment at a more granular level.
Ingest Keys are API Keys that you can use to send telemetry data to Honeycomb.
Ingest Keys have a single permission available: whether they can implicitly create datasets. If an event is sent to Honeycomb specifying a non-existent dataset, Honeycomb will create a new dataset if the associated Ingest Key can implicitly create datasets.
Ingest Keys are supported for Honeycomb Classic environments, provided the minimum required version of the software sending data in is in use. Please reference the table below to find the minimum supported version for your libraries, and upgrade, if necessary, prior to using Ingest Keys.
| Library | Minimum Version |
|---|---|
| beeline-go | 1.15.0 |
| beeline-java | 2.2.0 |
| beeline-nodejs | 4.1.0 |
| beeline-python | 3.6.0 |
| beeline-ruby | 3.1.0 |
| buildevents | 0.16.0 |
| honeycomb-opentelemetry-dotnet | 1.5.0 |
| honeycomb-opentelemetry-go | 0.10.0 |
| honeycomb-opentelemetry-java | 1.6.0 |
| honeycomb-opentelemetry-node | 0.7.0 |
| honeycomb-opentelemetry-python | 0.4.0b0 |
| honeycomb-opentelemetry-web | 0.0.4 |
| libhoney-dotnet | 1.4.0 |
| libhoney-go | 1.22.0 |
| libhoney-java | 1.6.0 |
| libhoney-js | 4.2.0 |
| libhoney-py | 2.4.0 |
| libhoney-rb | 2.3.0 |
| husky | 0.26.0 |
| refinery | 2.5.0 |
Configuration Keys are API Keys that you can use to manage resources in your Honeycomb Environments.
Configuration Keys may have any number of these permissions:
| API Key Permission | Auth API value | Description |
|---|---|---|
| Send Events | send events |
Send events to Honeycomb. Used as the API Key for sending data and for the Events API. |
| Create Datasets | create datasets |
Create and manage datasets via API. Datasets may also be created implicitly; if an event is sent to Honeycomb specifying a non-existent dataset, an event using an API key with this permission will create a new dataset. |
| Manage Queries and Columns | queries and columns |
Create and manage queries, columns, derived columns, and query annotations. |
| Run Queries | run queries |
Execute existing queries using the Query Data API. This feature is available as part of the Honeycomb Enterprise plan. |
| Manage Public Boards | boards |
Create and manage Boards. |
| Manage SLOs | SLOs |
Create and manage SLOs and their Burn Alerts. SLO Management is available as part of the Honeycomb Pro and Enterprise plans. SLO Reporting is only available on the Honeycomb Enterprise plan. |
| Manage Triggers | triggers |
Create and manage Triggers. |
| Manage Recipients | recipients |
Create and manage Recipients. |
| Manage Markers | markers |
Create and manage Markers. |
To see common issues when managing API Keys and their solutions, visit Common Issues with Configuring Honeycomb: API Keys.
