Skip to content
InternetData

Download

get/api/v1/database/download

Returns the requested database file as a binary download. The response's Content-Type depends on format: application/gzip for csvgz, application/octet-stream for mmdb.

Authorization

ApiKeyAuthapikey in query

UUID-format API key issued to the customer. Each key is authorized for a specific set of database ids; requesting any other id returns 403.

v1 only. The v2 endpoints take a console-issued key as a bearer token.

Query parameters

idrequiredstring

Database identifier (e.g. vpn_ip_v1, resproxy_provider_v1).

Match ^[a-zA-Z0-9_]+$ · Example vpn_ip_v1

formatrequired"csvgz" | "mmdb"

Database file format.

Example mmdb

Responses

200application/gzip

Database file.

string (binary)
TypeScript type
ts
string
400application/json

The request query parameters were malformed. Possible rc values: INVALID_FORMAT, INVALID_ID.

object | object
Option 1object
rcrequired"INVALID_FORMAT"
Option 2object
rcrequired"INVALID_ID"
TypeScript type
ts
{
  rc: "INVALID_FORMAT";
} | {
  rc: "INVALID_ID";
}
401application/json

The apikey query parameter was missing or not recognized.

rcrequired"INVALID_APIKEY"
TypeScript type
ts
{
  rc: "INVALID_APIKEY";
}
403application/json

The apikey is valid but is not authorized for the requested database id.

rcrequired"UNAUTHORIZED_ID"
TypeScript type
ts
{
  rc: "UNAUTHORIZED_ID";
}
404application/json

The requested database file does not exist on the server.

rcrequired"DB_NOT_FOUND"
TypeScript type
ts
{
  rc: "DB_NOT_FOUND";
}