Camera Webservice

Get current camera state

Use /getFullCameraState instead

post/api/camera/getCurrentState

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/camera/getCurrentState
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

cameraUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

forceboolean nullable

Whether to force a refresh of the camera state

Example request

{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "cameraState": {
    "baseVideoOperationUri": "https://api.example.com/video",
    "connectionTimestampMs": 1640995200000,
    "defaultInterface": "eth0",
    "defaultInterfaceMac": "00:11:22:33:44:55",
    "firmwareVersion": "1.2.3",
    "latestFirmwareVersion": "1.2.4",
    "mediaRegion": "us-west-1",
    "region": "us-west-1",
    "serialNumber": "CAM123456789",
    "ssid": "MyNetwork",
    "versionsBehind": 1,
    "wifiApMac": "AA:BB:CC:DD:EE:FF",
    "wifiBars": 4,
    "wifiSignalStrength": -45
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.