Download device inventory

Download device inventory

POST /api/export/inventory

Download device inventory

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/export/inventory \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}
'

200

{}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for exporting device inventory information to CSV format.

cameraUuids · (string<RUUID> | null)[] | null · deprecated

List of camera UUIDs to export (deprecated, use deviceUuids instead)

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

deviceUuids · (string<RUUID> | null)[] | null

List of device UUIDs to export inventory for

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - text/csv; charset=UTF-8

object | null

OK

The response is of type object.