mabl API keys enable programmatic access to the information in your mabl workspace. This guide provides an overview of the different API key types in mabl and how to manage them.
Note
API key access and usage is limited exclusively to workspace owners.
API key types
Different API keys are permissioned for different use cases. Keys only have the read/write permissions necessary for a specific use case.
See the following table for a list of available API key types in mabl and their uses:
| API key type | Use |
|---|---|
| CI/CD Integration | Use with mabl's CI/CD integrations, including Jenkins, Bamboo, Microsoft Azure DevOps, GitHub Actions, and Octopus Deploy. |
| Command Line Interface | Use with the mabl CLI. |
| Deployment Trigger | Use to start tests with the Deployment Events API and to retrieve test results with the Execution Result API. |
| Issue Tracker | Use with the mabl Jira plugin. |
| Link Agent | Use with the mabl Link agent. |
| Java Selenium Agent | Use with Selenium Java Agent. |
| Usage Analytics | Use with the mabl Segment integration. |
| Viewer | Use for mabl API endpoints that are read-only, such as the Reporting API |
The Integration key type is deprecated. Existing legacy Integration keys will continue to function, but users cannot create new API keys of this type.
Managing API keys
You can create, pause, unpause, and delete API keys. Visit the APIs page to get started: Settings > APIs.
The APIs page
Creating API keys
To create an API key, workspace owners can navigate to Settings > APIs and take the following steps:
- Click on the + Create API key button to open the Create API Key modal.
- Select the type of API key.
- Give the API key a name.
- Click on the Save button.
The new API key appears on the APIs page, where you can view, copy, pause, unpause, and delete the key.
Copying an API key
Pausing API keys
You can block access to an API key by toggling it off. Pausing an API key can be helpful if you want to remove an API but are unsure whether it's still in use.
For example, if you are rotating an API key, you can take the following steps:
- Create a new API key of the same type.
- Update the consuming integration with the new API key value.
- Pause the original API key that was used by the consuming integration.
- Confirm that the integration works as expected with the new API key.
- Delete the original, paused API key
Unpausing API keys
Toggling an API key on instantly re-enables API access for the key.
Removing API keys
Click on the trash icon to permanently remove an API key.
Deleted API key cannot be recovered
Ensure an API key is no longer in use before deleting the key. Once deleted, an API key cannot be restored, meaning any impacted scripts and services will be unable to access mabl. If any clients are using this key, they will no longer be able to access mabl services.
If you are unsure whether any scripts or services are still accessing the API, try pausing the API key first.