Project API Keys

Summary

In the side menu, open Settings, then select API on the project settings page. API keys are needed for external integrations that access the project API.

The list of API keys shows

• each key in the list shows its name;
• masked prefix;
• permissions;
• status: Active, Inactive, or Expired;
• date of creation;
• last use;
• validity period.

Creating an API key

• click the create key button to open the creation page;
• enter the name;
• choose permissions;
• set an expiration date when needed;
• change key activity when needed;
• click Save and copy the new key immediately.

Important

• the full key is shown only once;
• if the user closes the window and does not copy the key, it cannot be restored;
• you need to create a new key;
• the key cannot be sent to the support chat.

Permissions

• grouped by entities;
• you can select all or remove all;
• selecting all usually enables permissions to change data;
• grant only the required permissions.

Permission to view the current project is required for a project API key. It is locked in the form and always remains selected when the key is created or edited. "Deselect all" removes only optional permissions.

Viewing the key list requires access to project API keys. Creating, editing, and deleting them requires management access. If these actions are unavailable, check the project member role.

Editing an API key

• click Edit for the required key to open its editing page;
• you can change the name;
• you can change permissions;
• you can turn the activity on or off.

Removal

• dangerous action;
• open key deletion and confirm it separately;
• after deletion, requests with this key will stop working.

If the integration gets 401/403

• check if the key is active;
• check the expiration date;
• check permissions;
• check the project;
• check that the integration uses the current key.