Get minimal NVR state list

Get basic state information about all NVRs in organization

POST /api/relay/getMinimalNVRStateList

Get minimal NVR state list

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/getMinimalNVRStateList \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "nvrstates": [
    {
      "createdAtMillis": 123,
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "directionRadians": 123,
      "externalIPAddress": "<string>",
      "facetNameMap": {},
      "firmwareUpdateInProgress": true,
      "firmwareVersion": "<string>",
      "floorNumber": 123,
      "lanAddresses": [
        "<string>"
      ],
      "latitude": 123,
      "liveStreamShared": true,
      "liveStreamsSharedCount": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": 123,
      "mediaRegion": "<string>",
      "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "mummified": true,
      "name": "<string>",
      "numThirdPartyCamerasAssigned": 123,
      "numThirdPartyCamerasSupported": 123,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "region": "<string>",
      "secondaryLanAddresses": [
        "<string>"
      ],
      "serialNumber": "<string>",
      "ssid": "<string>",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "supportedFacets": [
        "v0, a0"
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "wifiApMac": "<string>",
      "wifiBars": 123,
      "wifiSignalStrength": 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 object for getting basic state information about all NVRs in the organization.

Response

200 - application/json

OK

Response object containing basic state information about all NVRs in the organization.

error · boolean | null

errorMsg · string | null

nvrstates · object[] | null

List of minimal NVR state information for all NVRs in the organization

Show child attributes

warningMsg · string | null