Camera

Get current camera state deprecated

Use /getFullCameraState instead

Warning

This operation is deprecated: it is kept for existing integrations; avoid it in new code. Use Get full camera state (/api/camera/getFullCameraState) instead.

POST/api/camera/getCurrentState

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to retrieve the current state of a camera (deprecated).

cameraUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

forceboolean | nullbody

Whether to force a refresh of the camera state

Example: false

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/camera/getCurrentState' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "force": false
  }'

import requests

url = "https://api2.rhombussystems.com/api/camera/getCurrentState"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "force": False
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/camera/getCurrentState', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "force": false
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
              "force": false
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/camera/getCurrentState"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "cameraState": {
    "baseVideoOperationUri": "https://api.example.com/video",
    "connectionStatus": "GREEN",
    "connectionTimestampMs": 1640995200000,
    "defaultInterface": "eth0",
    "defaultInterfaceMac": "00:11:22:33:44:55",
    "firmwareVersion": "1.2.3",
    "healthStatus": "GREEN",
    "healthStatusDetails": "NONE",
    "latestFirmwareVersion": "1.2.4",
    "mediaRegion": "us-west-1",
    "onCameraState": {
      "<key>": {}
    },
    "onCloudState": {
      "<key>": {}
    },
    "region": "us-west-1",
    "serialNumber": "CAM123456789",
    "ssid": "MyNetwork",
    "versionsBehind": 1,
    "wifiApMac": "AA:BB:CC:DD:EE:FF",
    "wifiBars": 4,
    "wifiSignalStrength": -45
  },
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

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

cameraStateobject

Current state information for a camera.

Show child attributes

baseVideoOperationUristring | null

Base URI for video operations

Example: "https://api.example.com/video"

connectionStatusenum<string>

Status enumeration for camera states.

Available options: RED, ORANGE, GREEN

connectionTimestampMsinteger<int64> | null

Connection timestamp in milliseconds

Example: 1640995200000

defaultInterfacestring | null

Default network interface

Example: "eth0"

defaultInterfaceMacstring | null

MAC address of default interface

Example: "00:11:22:33:44:55"

firmwareVersionstring | null

Current firmware version

Example: "1.2.3"

healthStatusenum<string>

Status enumeration for camera states.

Available options: RED, ORANGE, GREEN

healthStatusDetailsenum<string>

Detailed health status enumeration for cameras.

Available options: DISCONNECTED, FIRMWARE_BEHIND, NONE

latestFirmwareVersionstring | null

Latest available firmware version

Example: "1.2.4"

mediaRegionstring | null

Media region

Example: "us-west-1"

onCameraStateobject | null

State information stored on the camera

onCloudStateobject | null

State information stored in the cloud

regionstring | null

Camera region

Example: "us-west-1"

serialNumberstring | null

Camera serial number

Example: "CAM123456789"

ssidstring | null

WiFi SSID

Example: "MyNetwork"

versionsBehindinteger<int32> | null

Number of firmware versions behind

Example: 1

wifiApMacstring | null

MAC address of WiFi access point

Example: "AA:BB:CC:DD:EE:FF"

wifiBarsinteger<int32> | null

WiFi signal strength in bars (1-5)

Example: 4

wifiSignalStrengthinteger<int32> | null

WiFi signal strength in dBm

Example: -45

errorboolean | null

errorCodestring | null

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

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.