Who can use this feature?
- All roles with access level "high"
- Available on all plans
An API key allows you to generate an API token to use in external applications.
Generate a key
You can create multiple keys and revoke access as needed.
Access keys are intended for personal use when writing scripts/applications that access Catalyst API. Protect them as you protect your password, as they provide the same access to your user account. Do not share them with anyone.
Tokens are dependent upon the user with whom they're associated. If disabling or deleting Catalyst admin who has a personal access token in use for system integrations and APIs, the token must be replaced by a personal token of an active Catalyst admin.
- From within Catalyst, navigate to Settings > API Keys.
- Click Generate Key.
- Enter a key name that you will use to identify the key within Catalyst.
- Add a description for more detail, such as how the key will be used.
- Click Create.
Catalyst provides you with a new key.Do not close this window until you have copied the key.
- Copy the key before you close the window. You will not be able to access the key again.
- After copying, we recommend that you paste it directly into the third-party system.
- Click Finish.
The token is available to delete if you need to revoke access.
Delete an API key
When you delete an access token, any applications or scripts using the token will no longer be able to access the Catalyst API.
- From within Catalyst, navigate to Settings > API Keys.
- Locate the key you want to delete; from the Ellipses, click Delete Key.
- In the confirmation box, type DELETE to confirm.
- Click Delete.
FAQs
Question: Why is an API key tied to a Catalyst admin user?
Answer: It's a security and compliance best practice to track data changes back to individual users (i.e., audit log).