This method allows to obtain a JSON dump of all the devices in the Fingerbank database.

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"
fields
optional

Comma delimited list of fields to have in the dump. Allowed fields are: id, name, parent_id, virtual_parent_id, details. Default value is ‘id,name’ when the parameter isn’t specified

Validations:

  • Must be a String


Metadata:
Type: query parameter
Example: "?fields=id,name,parent_id"

Headers

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