Platform DocsPlayers DocsRelease Notes
API Reference
System StatusSubmit a CaseDashboard LoginCompany Site

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

API Key panel

API Key panel


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

  1. On the API Credentials page, under v2 API Credentials, click Add. The API Key panel appears.
  2. Enter a Name for the API key.
  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 several 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. The panel closes and the new API key with its generated secret appears under v2 API Credentials.

Edit an API key

Edit API Key panel

Edit API Key panel


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

  1. On the API Credentials page, under v2 API Credentials, hover over the row of the API key.
  2. Click ⋯ > Edit. The Edit API Key panel appears.
  3. Edit any of the API key properties.
    Item Description
    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 and the panel closes.

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.

v2 API Credentials section and Delete option

v2 API Credentials section and Delete option


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

  1. On the API Credentials page, under v2 API Credentials, 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 from under v2 API Credentials.