Get uptime information for an NVR.

Get uptime information for an NVR.

POST /api/relay/getUptimeWindows

Get uptime information for an NVR.

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/getUptimeWindows \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "endTimeMs": 1643673600000,
  "startTimeMs": 1640995200000
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "uptimeWindows": [
    {
      "durationSeconds": 123,
      "startSeconds": 123
    }
  ],
  "warningMsg": "<string>"
}

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 to get uptime information for a device.

deviceUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

endTimeMs · integer<int64> | null

End time in milliseconds since epoch

Example:

1643673600000

startTimeMs · integer<int64> | null

Start time in milliseconds since epoch

Example:

1640995200000

Response

200 - application/json

OK

Response containing uptime information for a device.

error · boolean | null

errorMsg · string | null

uptimeWindows · object[] | null

List of uptime windows for the device

Show child attributes

warningMsg · string | null