Get minimal camera list

Use /getMinimalCameraStateList instead

POST /api/camera/getMinimalList

Get minimal camera list

cURL

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

200

{
  "cameras": [
    {
      "defaultInterface": "eth0",
      "defaultInterfaceMac": "00:11:22:33:44:55",
      "floorNumber": 1,
      "lanAddresses": [
        "<string>"
      ],
      "latitude": 37.7749,
      "liveStreamShared": false,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "mediaRegion": "us-west-1",
      "mummified": false,
      "name": "Front Door Camera",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "region": "us-west-1",
      "serialNumber": "CAM123456789",
      "ssid": "MyNetwork",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "wifiApMac": "AA:BB:CC:DD:EE:FF",
      "wifiBars": 4,
      "wifiSignalStrength": -45
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "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 retrieve a minimal list of cameras (deprecated).

includeMummified · boolean | null

Whether to include mummified cameras in the response

Example:

false

Response

200 - application/json

OK

Response containing a minimal list of cameras (deprecated).

cameras · object[] | null

List of minimal camera information

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null