Skip to main content
An API Token is used by third-party applications or scripts to access to your organization via the Qovery API (CI/CD, Terraform, Pulumi, etc.). You can manage API tokens attached to your organization directly from the Qovery Console or using the Qovery CLI.
Qovery offers a second kind of token. An API Token carries a role and is the right choice for CI/CD, Terraform and scripts. An API Policy Token carries no role but a policy evaluated on every request, and is meant for autonomous agents that need a narrower footprint than any role can express, for example an agent that may only deploy the staging environment and never delete anything.

Accessing API Tokens

1

Open Organization Settings

Click the Settings tab while you are on your organization overview.
How to access your organization settings
2

Navigate to Token API Section

Open the Token API section within the organization settings
How to access your Token API section

Create a New Token

1

Click Add new Button

Press the Add new button to create a new API token
2

Configure Token

Provide the following information: - Name: A descriptive name for the token - Description: Purpose or usage details - Role: Select a role managed via the Qovery RBAC system
3

Save Token

After creation, the token will be displayed once

Check it worked

List the tokens of the organization:
The new token appears with its name and role_name. To confirm the token itself works, call the API with it:
The response lists the organizations the token can access.
Important: Make sure you safely store the token returned by the UI. You won’t be able to retrieve it again (you will have to create a new one).

Review Token Usage

Each token in the Token API list shows its role, its creation date, and Last used, the time elapsed since the token was last used, for example “Last used 3 days ago”. Hover over it to see the exact date and time in UTC. Use it to identify tokens that are no longer in use before you delete them. The Last used label is not displayed when no usage has been recorded for the token.

Delete a Token

To remove an API token:
  1. Locate the token in the Token API list
  2. Click the delete icon (trash icon) next to the token
  3. Confirm the deletion
With the API, call DELETE /organization/{organizationId}/apiToken/{apiTokenId}. Token IDs come from GET /organization/{organizationId}/apiToken.

Edit a Token

This functionality is not yet available. To modify a token, you’ll need to delete the existing one and create a new token.