Skip to main content
POST
/
api
/
relay
/
getDetails
Get NVR details
curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/getDetails \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "nvruuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "nvrs": [
    {
      "archiveRegion": "<string>",
      "cameraFramerate": 123,
      "createdAtMillis": 123,
      "customData": "<string>",
      "deleted": true,
      "description": "<string>",
      "deviceFacetRadians": {},
      "directionRadians": 123,
      "facetNameMap": {},
      "floorNumber": 123,
      "hwVariation": "RASPBERRY_PI_3",
      "latitude": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": 123,
      "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "mummified": true,
      "name": "<string>",
      "pending": true,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "primaryLinkSpeedMbps": 123,
      "secondaryLinkSpeedMbps": 123,
      "serialNumber": "<string>",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "totalStreamingPixels": 123,
      "type": "BLE_TRACKER",
      "unregisteredEmailSent": true,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

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 getting details for specified NVRs.

nvruuids
(string<RUUID> | null)[] | null

List of NVR UUIDs to get details for

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing details for specified NVRs.

error
boolean | null
errorMsg
string | null
nvrs
object[] | null

List of NVR details for the specified NVRs

warningMsg
string | null