API
API keys can be used to integrate Scanners, register Releases from continuous delivery pipelines, or interact with Ctrlplane programmatically. They are essential for automating workflows, integrating with external tools like the Terraform Cloud Scanner or GitHub Actions Dispatcher, and building custom integrations with your existing infrastructure management systems.
Dirrect API access can be configured by navigating to
https://${CTRLPLANE_BASE_URL}/${WORKSPACE_SLUG}/ettings/account/apito create a key.
Creating an API Key
To create a new API key, follow these steps:
- Navigate to the API section in your account settings.
- Enter a name for your API key in the “Name” field.
- Click on the “Create new API key” button.
Once the API key is generated, it will only be shown once. Make sure to copy it and store it securely, as you will not be able to view it again.
Revoking an API Key
If you no longer need an API key or suspect it has been compromised, you can revoke it at any time. To revoke an API key:
- Locate the API key you wish to revoke in the API section.
- Click the “Revoke” button next to the corresponding key.
This action will immediately disable the API key, preventing any further access using that key.