Authenticate to the API

Create an API key and make your first request. You authenticate with a bearer token, and every endpoint needs 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 dashboard shows the key once, at creation. Copy it into your secret store right away. You can’t retrieve it later. If you lose it, create 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.

Caution

A key acts as the person who created it. If they lose access to the account (their seat is removed, or they leave the connected Git organization), the key stops working and returns a 401. When someone who owns automation leaves, create a replacement key first.

What’s next

Sourcery API What the API covers 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.