Skip to main content
POST
/
api
/
camera
/
getMinimalCameraStateList
Get minimal camera state list
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getMinimalCameraStateList \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "includeMummified": false
}
'
{
  "cameraStates": [
    {
      "connectionStatus": "RED",
      "createdAtMillis": 123,
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "directionRadians": 123,
      "externalIPAddress": "<string>",
      "facetNameMap": {},
      "firmwareUpdateInProgress": true,
      "firmwareVersion": "<string>",
      "floorNumber": 123,
      "healthStatus": "RED",
      "healthStatusDetails": "DISCONNECTED",
      "hwVariation": "RASPBERRY_PI_3",
      "lanAddresses": [
        "<string>"
      ],
      "latitude": 123,
      "liveStreamShared": true,
      "liveStreamsSharedCount": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": 123,
      "mediaRegion": "<string>",
      "mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "mummified": true,
      "name": "<string>",
      "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
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "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 to retrieve a minimal list of camera states.

includeMummified
boolean | null

Whether to include mummified cameras in the response

Example:

false

Response

200 - application/json

OK

Response containing a minimal list of camera states.

cameraStates
object[] | null

List of minimal camera state information

error
boolean | null
errorMsg
string | null
warningMsg
string | null