Skip to content

Authentication

Vulners API uses API keys via HTTP headers for all authenticated requests.

Header Format

X-Api-Key: YOUR_API_KEY

Example Request

Using curl: 

curl -X POST https://vulners.com/api/v4/audit/software/ \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR-API-KEY>" \
  -d '{
    "software": [{"product": "django", "version": "1.9"}], "fields": []
  }'

How to obtain API key

An Application Programming Interface (API) key is a unique identifier used to authenticate and authorize API calls. Each license—free, trial, basic, pro, advanced, etc.—requires its own API key. The following guide shows you how to quickly generate an API key.

1) Register an account:

register

register

2) Log In and access API keys tab

log in after registration

3) Generate an API Key

  • Choose a name for your API key.
  • Select the appropriate scope from the list below:
  • webhook — Authorize notification webhook
  • scan — Use in a Linux agent
  • api — Authorize any API calls
  • errata — Authorize Vulners Centos Errata
  • reports — Generate Linux scanner reports

scope

  • Select the license type:

scope

Optionally, restrict access to your API key by specifying IPv4 addresses.

4) Save Your API Key. Your API key is now ready to use!

api key

If you have any questions, please contact us.

Deprecation Notice

Passing the API key as part of the request body using the apiKey parameter is deprecated and will be fully removed.