API key
Learn more about API keys and how to generate them.
API keys let you connect to our administration and service APIs to manage your account or interact with our services programmatically.
You can create and manage your API keys on the API keys page.
You must have an Owner or Manager role to create API keys. Learn more in Roles and permissions.
Generate an API key
Follow these steps to create a new API key:
Go to the API keys page.
Click New.
Enter a name for the key.
Select the permissions carefully. You cannot change them after the key is created.
Click Save to finish.
Available permissions:
| Permission | Related service | Description |
|---|---|---|
| Read resources | CLI | Read-only access to all resources in the application hierarchy. |
| Export data | Export API | Read-only access to export events, sessions, and user data from the application. |
Your API key is shown only once. Copy it and store it in a safe place. If you lose it, you must create a new one.
After creating the key, you can start using it by following the service APIs documentation.
Revoke an API key
To revoke an API key, you must simply delete it. Once you do that, services using the key will no longer be able to reach our endpoints.
If you believe your API key may have been compromised, revoke it immediately.