Skip to content
VPNDetection

Download

get/api/v1/database/download

Answers 302 with a time-limited URL pointing straight at object storage. Follow the redirect; the link authorizes the START of a transfer, so one already running is not interrupted when it lapses.

Authorization

apiKeyQueryapikey in query

?apikey=<key>. Convenient in a browser; prefer a header elsewhere.

apiKeyHeaderX-Api-Key in header

X-Api-Key: <key>.

bearerAuthbearer token

Authorization: Bearer <key>.

Query parameters

idrequiredstring

Dataset id, e.g. vpn_ip_extended_v1

formatrequired"csvgz" | "mmdb"

Not every database is built in every format. The _provider catalogs are keyed by provider id rather than by IP range, so no MMDB exists for them.

Responses

302

Follow the Location header to object storage

400application/json

The database is not built in the requested format

rcrequiredstring
TypeScript type
ts
{
  rc: string;
}
401application/json

Missing or invalid key, or the key lacks the db.download scope

rcrequiredstring
TypeScript type
ts
{
  rc: string;
}
403application/json

Your organization holds no license for this database, or its term has ended

rcrequiredstring
TypeScript type
ts
{
  rc: string;
}
404application/json

No such database

rcrequiredstring
TypeScript type
ts
{
  rc: string;
}
503application/json

Licensed, but today's copy has not been published yet

rcrequiredstring
TypeScript type
ts
{
  rc: string;
}