GET /api/v2/download/db

This method allows to download a database containing the attributes tables and the devices (HTTP User-Agent are not included)

Supported Formats

Request : */*, Response : application/sqlite3

Errors

Code Description
401 This request is unauthorized. Either your key is invalid or wasn't specified.
403 This request is forbidden. Your account may have been blocked.
429 The amount of requests per minute has been exceeded. All accounts (even the unlimited ones) are rate limited to 250 requests per minute unless agreed otherwise with Inverse.
502 No API backend was able to process the request. The system may be overloaded, in maintenance or experiencing an issue. Retrying shortly after should work.

Params

Param name Description
key
required

Your API key (you can optionally use the Authorization header for improved security)

Validations:

  • Must be a String


Metadata:
Type: query parameter
Example: "?key=68989f507420b6187c7e4fa32245db311efed505"

Headers

Header name Description
Authorization
optional
Authorization header containing your API key (Bearer standard). Example value for the header: `Bearer 68989f507420b6187c7e4fa32245db311efed505`

GET /api/v2/download/on-prem-db

WARNING: This API endpoint is only available through licensing - contact us for details.

Download an SQLite3 database for usage with the standalone Fingerbank Processing Engine.

Supported Formats

Request : */*, Response : application/sqlite3

Errors

Code Description
401 This request is unauthorized. Either your key is invalid or wasn't specified.
403 This request is forbidden. Your account may have been blocked.
429 The amount of requests per minute has been exceeded. All accounts (even the unlimited ones) are rate limited to 250 requests per minute unless agreed otherwise with Inverse.
502 No API backend was able to process the request. The system may be overloaded, in maintenance or experiencing an issue. Retrying shortly after should work.

Params

Param name Description
key
required

Your API key (you can optionally use the Authorization header for improved security)

Validations:

  • Must be a String


Metadata:
Type: query parameter
Example: "?key=68989f507420b6187c7e4fa32245db311efed505"

Headers

Header name Description
Authorization
optional
Authorization header containing your API key (Bearer standard). Example value for the header: `Bearer 68989f507420b6187c7e4fa32245db311efed505`

GET /api/v2/download/ip-blacklist

WARNING: This API endpoint is only available through licensing - contact us for details.

Download the official Fingerbank IP blocklist. IPs contained in this database are known to be malicious. Each line contains a CIDR that is considered malicious.

Supported Formats

Request : */*, Response : text/plain

Errors

Code Description
401 This request is unauthorized. Either your key is invalid or wasn't specified.
403 This request is forbidden. Your account may have been blocked.
429 The amount of requests per minute has been exceeded. All accounts (even the unlimited ones) are rate limited to 250 requests per minute unless agreed otherwise with Inverse.
502 No API backend was able to process the request. The system may be overloaded, in maintenance or experiencing an issue. Retrying shortly after should work.

Examples

206.209.192.0/20
206.221.0.0/20
206.221.96.0/20
206.221.192.0/20
206.223.17.0/24
206.223.33.0/24

Params

Param name Description
key
required

Your API key (you can optionally use the Authorization header for improved security)

Validations:

  • Must be a String


Metadata:
Type: query parameter
Example: "?key=68989f507420b6187c7e4fa32245db311efed505"

Headers

Header name Description
Authorization
optional
Authorization header containing your API key (Bearer standard). Example value for the header: `Bearer 68989f507420b6187c7e4fa32245db311efed505`

GET /api/v2/download/destination-hosts

Download a list of all the destination hosts Fingerbank is able to recognize. With this list, you can implement filtering on which destination hosts you should be tracking and include in the destination_hosts field in /api/v2/combinations/interrogate.

This API endpoint provides a list of entries (one per line). Each entry is either a regular expression match (surrounded by slashes) or an exact string match (no surrounding slashes). Entries may also contain a port.

Supported Formats

Request : */*, Response : text/plain

Errors

Code Description
401 This request is unauthorized. Either your key is invalid or wasn't specified.
403 This request is forbidden. Your account may have been blocked.
429 The amount of requests per minute has been exceeded. All accounts (even the unlimited ones) are rate limited to 250 requests per minute unless agreed otherwise with Inverse.
502 No API backend was able to process the request. The system may be overloaded, in maintenance or experiencing an issue. Retrying shortly after should work.

Examples

zone2-device.cloud.xirrus.com:53
zone2-device.cloud.xirrus.com
ztedesktopwidget.accu-weather.com
/.*.ztems.com:443/
/xbroker[0-9]+-z2.arloxcld.com/

Params

Param name Description
key
required

Your API key (you can optionally use the Authorization header for improved security)

Validations:

  • Must be a String


Metadata:
Type: query parameter
Example: "?key=68989f507420b6187c7e4fa32245db311efed505"

Headers

Header name Description
Authorization
optional
Authorization header containing your API key (Bearer standard). Example value for the header: `Bearer 68989f507420b6187c7e4fa32245db311efed505`