Add roles to your API key

An API key grants an integration the permissions of its assigned roles. Create separate keys for separate systems and assign only the access each system needs.

Adding an API key

  1. Open the account menu, select Developers, and open API Keys. This area requires administrator access.
  2. Click Add Key to open the create-key dialog.
  3. Enter a required Name, an optional Description, and select at least one role.
  4. Click Create.
  5. Copy the generated key and store it securely before closing the dialog.
🚧

The generated key is shown only once. If you lose it, create a replacement.

Editing an API key

Open the key’s actions menu and select Edit. Update its name, description, or roles, then click Save. Changing the roles changes the access available to the integration.

Removing an API key

Open the key’s actions menu and select Delete, then review and complete the confirmation in the application.

🚧

Applications using a deleted key lose access. Replace the key in each integration before deleting it during a planned rotation.

Current Create API Key dialog; no credential has been created

See also: current walkthrough.


Did this page help you?