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,
      "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,
      "unregisteredEmailSent": true,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

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 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
Last modified on May 20, 2026