Manage Team 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:

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

​

Create Management API Key

To create your API Key:

1. Log in to the Honeycomb UI.
2. From the navigation bar, select Account, and then Team Settings.
3. Select the API Keys view.
4. Select Create Management API Key.
5. In the Create Management API Key modal, enter the details for your API Key:

   Field	Description
   Name	Label for the API Key. Used to identify this key in the Honeycomb UI.
   Scopes	Actions this key is allowed to perform on Honeycomb resources. For a full list of available scopes, visit Management Key Scopes.

   Choose scopes carefully; they are permanent. To change scopes, you must delete the API Key and create a new one.
6. Select Create.
7. Copy your Secret and save it to a secure location. Honeycomb returns it only upon creation.
   Store your API keys securely and never check them into version control systems, such as Git.
8. Select I’ve copied the secret.
9. Optionally, copy your Key ID. You will need both your Key ID and Secret to authenticate requests to the API. Your Key ID is always available after creation, but your Secret is not.

Your new API Key appears in the list of keys. To learn how to use your new key, visit API Documentation: Authentication.

​

Disable Management Keys

To disable your Management Key:

1. Log in to the Honeycomb UI.
2. From the navigation bar, select Account, and then Team Settings.
3. Select the API Keys view.
4. In the list, locate the Management Key that you want to disable, and select Details to view its settings.
5. Locate the Enable checkbox, and deselect it.
6. 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

To delete your Management Key:

1. Log in to the Honeycomb UI.
2. From the navigation bar, select Account, and then Team Settings.
3. Select the API Keys view.
4. In the list, locate the Management Key that you want to delete, and select Details to view its settings.
5. Select Delete.
6. In the Delete Management API Key? modal, enter the name of the Management Key (located above the field).
7. 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.

​

API Keys