Skip to content

Deprecating HTTP headers for API tokens April 1, 2020#

On April 1st, 2020 we're deprecating the following HTTP headers used to authenticate to the Codacy API using either an API token or project token:

  • api_token
  • project_token

From this date onward, use the following HTTP headers instead:

  • api-token
  • project-token

How does this change impact me?#

We will support the new and old HTTP headers simultaneously for some time. However, we intend to drop the support for the old HTTP headers in the future.

As such, to avoid downtime in your operations, we recommend that you do the following as soon as possible:

  • Update the Codacy Coverage Reporter to version 7.6.6 or later
  • Update the Codacy Analysis CLI to version 3.0.0 or later
  • If you have any custom tools or scripts that integrate with the Codacy API, update them to use the new HTTP headers.

Background information#

By default, NGINX silently drops HTTP headers containing underscores. With the old HTTP headers, this would require an extra configuration step during the Codacy installation process.

We decided to avoid this extra complexity by changing to the new HTTP headers that don't include underscores.

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.

Edit this page on GitHub if you notice something wrong or missing.

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

Last modified August 26, 2022