VPNDetectionVPNDetection

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

apikey<token>

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

In: query

Query Parameters

id*string

Dataset id, e.g. vpn_ip_extended_v1

format*string

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

Value in"csvgz" | "mmdb"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vpndetection.io/api/v1/database/download?id=string&format=csvgz"
Empty
{
  "rc": "string"
}
{
  "rc": "string"
}
{
  "rc": "string"
}
{
  "rc": "string"
}
{
  "rc": "string"
}

List GET

Every database this organization may SEE, with where its licence stands. Not just the ones you hold: a customer with one grant should be able to tell what else is published without asking. `standing` is the difference - `licensed`, `expired`, or `unlicensed` for one never bought.

Metadata GET

Poll this to decide whether today's build is worth fetching: it carries `updated` and `entries` without downloading anything. No `format` parameter - one document describes every format the database is built in.