Manage API Keys
Securely manage, generate, and delete API keys for external access.
API keys in Workbase provide secure access to your organization’s data for external applications or systems. This guide covers how to generate, rename, and delete API keys.
Accessing API Keys
Navigate to Settings
Click the Settings icon in the navigation bar and select the API Keys tab.
Generating a New API Key
Click "Generate API Key"
Enter a name for the key, and if necessary, set an expiration date. If you leave the expiration date blank, the key will remain active indefinitely.Important
After the key is generated, it will be displayed only once. Make sure to copy it and store it securely, as you won’t be able to retrieve the key later.
Managing Existing API Keys
Renaming an API Key
To rename a key, click the Edit button next to it, enter a new name, and save your changes.Deleting an API Key
To delete an API key, click the Delete button next to the key. This action will permanently remove the key, and any systems using it will immediately lose access.
Expiration Dates and Renewals
Once an API key expires, it cannot be reactivated or renewed. If a key expires, you will need to generate a new one.
Frequent Questions
Last updated: September 1, 2024