> ## Documentation Index
> Fetch the complete documentation index at: https://support.blackbirdsec.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentication

> BLACKBIRD provides an extensive API to start, delete, and view scans at any time.

BLACKBIRD provides a REST API to launch, delete, and view scans at any time. But also to seamlessly integrate your Pentesting Suite with your other tooling to parse or pull data easily in JSON.

Authentication is done using the `X-API-KEY` HTTP request header to help us identify your session and account.

```bash theme={null}
'X-API-Key': '<API_KEY>'
```

<Warning>
  Make sure to treat this key as a secret and never share it with anyone else.
</Warning>

## Requesting an API Key

To request an API key:

1. Go to your [Profile](https://app.blackbirdsec.eu/account/profile)
2. Scroll down to the **API** section
3. And click on **+ New API Key**

Once your key is generated, make sure to save it somewhere safe (preferably in an encrypted password manager) as you won't be able to view it again.

<Warning>
  Your API Key is only displayed to you once! Make sure to save it somewhere safe and never share it with anyone else!
</Warning>
