Skip to main content
POST
/
api
/
camera
/
getCurrentState
Get current camera state
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getCurrentState \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "force": false
}
'
{
  "cameraState": {
    "baseVideoOperationUri": "https://api.example.com/video",
    "connectionStatus": "RED",
    "connectionTimestampMs": 1640995200000,
    "defaultInterface": "eth0",
    "defaultInterfaceMac": "00:11:22:33:44:55",
    "firmwareVersion": "1.2.3",
    "healthStatus": "RED",
    "healthStatusDetails": "DISCONNECTED",
    "latestFirmwareVersion": "1.2.4",
    "mediaRegion": "us-west-1",
    "onCameraState": {},
    "onCloudState": {},
    "region": "us-west-1",
    "serialNumber": "CAM123456789",
    "ssid": "MyNetwork",
    "versionsBehind": 1,
    "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 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 the current state of a camera (deprecated).

cameraUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

force
boolean | null

Whether to force a refresh of the camera state

Example:

false

Response

200 - application/json

OK

Response containing the current state of a camera (deprecated).

cameraState
object

Current state information for a camera.

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