Skip to main content
POST
/
api
/
export
/
uptime
Download device uptime reports
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",
  "granularity": "NANOSECONDS",
  "startDateTime": "2024-01-01T00:00:00Z"
}
'
{}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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> | null

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.