Skip to content

Project API

The Codacy API offers specific methods to manipulate repositories. To use these API methods, run local analysis, or send coverage results for your repository, you must use a project API Token generated specifically for your repository. Each project API Token is only valid for one repository.

Warning

Never write API tokens on your configuration files and keep your API tokens well protected, as they grant owner permissions to your projects.

We recommend that you set API tokens as environment variables. Check the documentation of your CI/CD platform on how to do this.

To generate an API token:

  1. Open your repository Settings, tab Integrations, click the button Add integration, and add a Project API integration.

  2. Click the button Settings for the project API integration to copy the new API Token.

    Project API Token

To revoke an API Token, clicking the trash can icon to remove the Project API integration.

Tip

You can create multiple Codacy API Tokens. This can be useful to have a more flexible control by revoking only a specific token.

See also

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?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help please contact support@codacy.com.

Last modified March 5, 2021