Codacy provides account and project-level API tokens that allow you to:
- Upload coverage data to Codacy
- Upload the results of running local analysis to Codacy
- Authenticate when using the Codacy API
The sections below provide details about the two types of API tokens and instructions on how to generate and revoke them.
Never write API tokens to your configuration files and keep your API tokens well protected, as they grant owner permissions to your projects on Codacy.
We recommend that you set API tokens as environment variables. Check the documentation of your CI/CD platform on how to do this.
Generating and revoking account API tokens#
Account API tokens are defined at the Codacy user account level. Each account API token authorizes access to the same organizations, repositories, and operations as the roles and permissions of the owner of the account.
If you're using an account API token to upload coverage be sure to check the roles that your Git provider account must have to authorize uploading coverage to Codacy.
We recommend that you use a dedicated service account for integrating Codacy with your repositories. This will avoid disruption of service if the user who originally created an account API token stops having access to the repositories, such as when the user leaves the team or the organization.
You can create new account API tokens programmatically using the Codacy API or using the Codacy UI:
Open your account, tab Access management.
Click the button Create API token under Account API tokens.
You can create multiple account API tokens. This can be useful to have a more flexible control by revoking only a specific token.
To revoke an account API token, click the "X" next to the token. After this, all applications or services using that token to access the Codacy API will fail to authenticate and will receive the reply
Generating and revoking project API tokens#
Project API tokens are defined on individual repositories. Each project API token only authorizes access to the corresponding repository.
You can create new project API tokens programmatically using the Codacy API or using the Codacy UI:
Open your repository Settings, tab Integrations.
Click the button Add integration and add a Project API integration.
Click the button Settings on the Project API integration and copy the project API token.
You can create multiple (up to 100) project API tokens per repository. This can be useful to have a more flexible control by revoking only a specific token.
To revoke a project API token, click the trash can icon for the corresponding Project API integration. After this, all applications or services using that token to access the Codacy API will fail to authenticate and will receive the reply
- Adding coverage to your repository
- Running local analysis
- Client-side tools
- Creating project API tokens programmatically
Share your feedback 📢
Did this page help you?
Thanks for the feedback! Is there anything else you'd like to tell us about this page?
255 characters left
We're sorry to hear that. Please let us know what we can improve:
255 characters left
Alternatively, you can create a more detailed issue on our GitHub repository.
Thanks for helping improve the Codacy documentation.
Edit this page on GitHub if you notice something wrong or missing.
If you have a question or need help please contact firstname.lastname@example.org.