Download device uptime reports

Download device uptime reports

POST /api/export/uptime

Download device uptime reports

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/export/uptime \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endDateTime": "2024-01-31T23:59:59Z",
  "startDateTime": "2024-01-01T00:00:00Z"
}
'

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 uptime reports with configurable time ranges and granularity.

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

Use deviceUuids instead

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

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

List of device UUIDs to export uptime reports for

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endDateTime · string | null

End date and time for the uptime report

Example:

"2024-01-31T23:59:59Z"

granularity · enum<string>

Time granularity for the uptime report

Available options: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

startDateTime · string | null

Start date and time for the uptime report

Example:

"2024-01-01T00:00:00Z"

Response

200 - application/zip

object | null

OK

The response is of type object.