Authenticate to the API

Create an API key and make your first request. The API authenticates with a bearer token, and the endpoints it reaches need a Team-plan account.

Create a key and call the API

1. Create a key

   Go to API Keys and create a key.

2. Store it now

   The key is shown once, at creation. Copy it into your secret store right away. You can’t retrieve it later, so a lost key means creating a new one.

3. Make a request

   Pass the key in the Authorization header as a bearer token:

   curl https://api.sourcery.ai/api/v1/security-issues \
     -H "Authorization: Bearer $SOURCERY_API_KEY"

Caution

The endpoints require security scanning, a Team-plan capability. A key created on a lower plan returns a 403 until the account is on the Team plan.

What’s next

Sourcery API The full endpoint list and the live OpenAPI reference.

Findings and severity How the findings the API returns are scored and grouped.

Triage a finding The status and severity actions the bulk-patch endpoint drives.