Team-level Management API Keys

Management API Keys allow you to manage API Keys at the Team level, which includes all API Keys for the Environments associated with your team.

Create and manage these team-scoped Management API Keys through the Honeycomb UI. We require you to manually create a Management API Key. When you create a Management API Key, you assign it a set of scopes, which determine what actions the API Key can perform in the associated Team.

Use Management API Keys to authorize the Key Management API. Refer to the Key Management API documentation for details.

Any programmatic request sent to Honeycomb must use an API Key, but most Honeycomb APIs operate at the Environment level and require a Configuration Key for resource management. To learn more about using API Keys, visit Best Practices for API Keys.

Find Management API Keys

To find your existing Management API Keys:

Log in to the Honeycomb UI.
From the navigation bar, select Account, and then Team Settings.
Select the API Keys view.

Create Management API Key

Important

To create a Management API Key, you must be a Team Owner.

Warning

For security reasons, you can access the secret portion of your Management API Key only while creating it. You may be able to use the information you retrieve in this section to identify a key or its settings, so you can retrieve it from the safe location in which you previously stored it.

To create your API Key:

Log in to the Honeycomb UI.
From the navigation bar, select Account, and then Team Settings.
Select the API Keys view.
Select Create Management API Key.
In the Create Management API Key modal, enter a Name for the API Key, and select the scopes you would like assigned to the API Key.

To learn more about the scopes that you can assign to API Keys, visit the Management Key scopes section.

Warning

You cannot change the API Key’s scopes after creation, but you can delete the API Key.
Select Create.
Copy your Key Secret and save it to a secure location. For security reasons, you will not be able to see the secret portion of the API Key again.

Warning

For production deployments, you should store your API Key securely and never check them into source control management systems, such as Git.
Select I’ve copied the key secret.
Optionally, copy your Key ID. To use the Management API, you will need both the Key Secret and the Key ID. Unlike the Key Secret, the Key ID is available after creation.

Your new API Key should now appear in the list of keys. To use these keys, refer to the Key Management API documentation for details.

Disable Management Keys

Important

To disable a Management Key, you must be a Team Owner.

To disable your Management Key:

Log in to the Honeycomb UI.
From the navigation bar, select Account, and then Team Settings.
Select the API Keys view.
In the list, locate the Management Key that you want to disable, and select Details to view its settings.
Locate the Enable checkbox, and deselect it.
Select Save.

Your Management Key will appear grayed out in the list, but it may take several minutes for the process to complete.

Delete Management Keys

Warning

Management Key deletion is permanent, so make sure you really want to delete your Management Key before doing so.

To delete a Management Key, you must be a Team Owner.

To delete your Management Key:

Log in to the Honeycomb UI.
From the navigation bar, select Account, and then Team Settings.
Select the API Keys view.
In the list, locate the Management Key that you want to delete, and select Details to view its settings.
Select Delete.
In the Delete Management API Key? modal, enter the name of the Management Key (located above the field).
Select Delete.

Your Management Key will no longer appear in the list, but it may take several minutes for the process to complete.

Management Key Scopes

You can control the actions that a Management API Key may perform in your Team at a more granular level.

Note

You cannot change scopes assigned to a Management Key after the key has been created. Management Keys can be deleted.

API Keys

Scope	Description
`api-keys:read`	Grants `list` and `view details` to the team’s API Keys.
`api-keys:write`	Grants `create`, `list`, `update`, `delete` and `view details` for the team’s API Keys.
`environments:read`	Grants `list` and `view details` to the team’s Environments.
`environments:write`	Grants `create`, `list`, `update`, and `view details` for the team’s Environments.

Honeycomb.io Documentation