🚧

Codecov API v1 deprecation in progress

Please use the Codecov API v2. Documentation can be found here.

To access Codecov's API as an authenticated user please create an access token in Codecov. To create an access token please follow these directions:

  1. Navigate to your personal (not org) account page by clicking on your avatar (top right corner) then Settings
  2. Click on Access on the left side menu
  3. Click on Generate Token button
  4. Type in a token name and click Generate
  5. Use this token in your API requests as stated below.

You can pass the token in the query params or in the request headers as seen in the two examples below.

Using the query string (not as secure, due to visible token)

GET https://codecov.io/api/pub/{gh|gl|bb}/{owner}/{repo}/settings?access_token=<token>

Using the headers (recomended method)

curl -X GET https://codecov.io/api/pub/{gh|gl|bb}/{owner}/{repo}/settings \
     -H 'Authorization: {token}'