Create and manage API keys

A secret is required to authorize access to the Management API and its resources.

The following are the key features of the secret:

• Multiple secrets can be created for each property.
• Each secret can be granted unique permissions.
• Secret scope and permissions can be edited after creation.
• Secrets can be deleted.

❗️

If a security breach occurs with your API secret, delete the affected secret.

---

Create a new API key

Follow these steps to create a new API key and generate a new secret:

1. On the Management API tab, click Create API key. The API key page appears.
2. Enter the API key name.
3. From the User role dropdown menu, select the role to assign to the API key.
4. Under Properties, click the checkbox next to one or multiple properties to which the API key should be granted access.

   📘

   If the Admin role was selected in the previous step, the Properties options will be grayed out. Admins are automatically granted access to all properties.

5. Click Save API key. The new API key with its generated secret appears in the table on the Management API tab.

---

Edit an API key

Follow these steps to edit the properties of the API key:

1. On the Management API tab, hover over the row of the relevant API key.
2. Click ⋯ > Edit. The API key page appears.
3. Edit any of the API key properties.

   Item	Description
   API key name	Display name of the API key
   User role	Role corresponding to the permissions granted to the API key
   Properties	Properties to which the API key should be granted access If the Admin role has been selected as the User role, this section is grayed out. Admins are automatically granted access to all properties.

4. Click Save. The API key is updated.

---

Delete an API key

❗️

Deleting an API key is permanent. Before deleting an API key, confirm that its secret is not associated with any services or code that you have created.

Follow these steps to delete an API key and its secret:

1. On the Management API tab, hover over the row of the API key.
2. Click ⋯ > Delete. The Delete API key popup window appears.
3. Click Delete. The popup window closes and the API key is removed.