Skip to main content

API keys

Learn about API keys and how to manage them in the console. API key management is available for Admin users only.

How API keys work?​

API keys feature is a recommended way of authenticating calls to Cloud Video Kit API methods (read more: Authorization). You can manage different levels of access to the Cloud Video Kit features by assigning roles to your API keys. This is the same set of roles you can assign to the tenant members. You will find more information in the Roles & their permission scopes article.

You can generate as many API keys for your tenant as you need.

info

Careful key distribution enhances the security of your content. You can modify API keys permission scope or delete API keys from your tenant at any time.

Generating & viewing API keys​

To generate a new API key for your tenant, follow the steps below:

  1. Go to Settings page in the Admin module.
  2. Switch to API key tab.
  3. Find the New API key window above the table, fill the Name and select a Role from the dropdown list.
  4. Click the Generate button.

Generated API keys will be listed in the table below. You can also find API keys list on the API Cheatsheet page and on the Configuration page in the DRM module.

Editing API keys​

As an Admin, you can change an existing API key’s name and its role. You can’t change the API key value.

caution

Changing key Role results in changing the access scope assigned to this key. Make sure it's not used in any integration that require higher scope access.

To edit an API key for your tenant, follow the steps below:

  1. Go to Settings page in the Admin module.
  2. Switch to API key tab.
  3. Find the API key you wanted to edit in the table.
  4. Click the pencil icon in the Actions column.
  5. Change API key Name and/or select a different Role from the dropdown list.
  6. Approve the changes using check icon in the Actions column.
  7. If you changed the API key role, type in API key Name in the modal and click Change role button.

Deleting API keys​

info

Deleting API keys results in an immediate key invalidation. This feature might prove useful either if you would like to enhance the security by implementing key rotation or in case of a breach.

To delete the API key for your tenant, follow the steps below:

  1. Go to Settings page in the Admin module.
  2. Switch to API key tab.
  3. Find the API key you want to edit in the table.
  4. Click the trash bin icon in the Actions column.
  5. Type in API key Name in the modal and click Delete key button.