Relay (third-party cameras)

Add third party camera via ONVIF

Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials.

POST/api/relay/addThirdPartyCameraViaOnvif

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 write 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

Add a third-party camera via ONVIF from an IP address and credentials.

autoAssignboolean | nullbody

Provision (assign to the NVR) automatically after a successful probe. Defaults to false (probe-then-confirm).

ipAddressstring | nullbody

IPv4 address of the camera to probe

Example: "10.5.4.20"

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

namestring | nullbody

Camera name. When blank, derived from the ONVIF manufacturer and model.

nvrUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

passwordstring | nullbody

ONVIF password to try first (optional)

trySavedCredentialsboolean | nullbody

Also try the org's saved third-party camera credentials. Defaults to true.

usernamestring | nullbody

ONVIF username to try first (optional)

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/relay/addThirdPartyCameraViaOnvif' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "autoAssign": true,
    "ipAddress": "10.5.4.20",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "nvrUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "password": "<string>",
    "trySavedCredentials": true,
    "username": "<string>"
  }'

import requests

url = "https://api2.rhombussystems.com/api/relay/addThirdPartyCameraViaOnvif"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "autoAssign": True,
    "ipAddress": "10.5.4.20",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "nvrUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "password": "<string>",
    "trySavedCredentials": True,
    "username": "<string>"
}

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

const response = await fetch('https://api2.rhombussystems.com/api/relay/addThirdPartyCameraViaOnvif', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "autoAssign": true,
    "ipAddress": "10.5.4.20",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "nvrUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "password": "<string>",
    "trySavedCredentials": true,
    "username": "<string>"
  }),
});
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 = """
            {
              "autoAssign": true,
              "ipAddress": "10.5.4.20",
              "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "name": "<string>",
              "nvrUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "password": "<string>",
              "trySavedCredentials": true,
              "username": "<string>"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/relay/addThirdPartyCameraViaOnvif"))
            .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

{
  "assignedDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "assignmentMsg": "<string>",
  "codec": "<string>",
  "error": false,
  "errorCode": "<string>",
  "found": true,
  "ipAddress": "<string>",
  "macAddress": "<string>",
  "manufacturer": "<string>",
  "model": "<string>",
  "name": "<string>",
  "rtspUrl": "<string>"
}

Response

200 OK

application/json · object

Result of adding a third-party camera via ONVIF.

assignedDeviceUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

assignmentMsgstring | null

Why auto-assignment did not happen or failed, when applicable

codecstring | null

Detected codec(s)

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

foundboolean | null

Whether an ONVIF-streamable camera was found at the address

ipAddressstring | null

Resolved camera IP address

macAddressstring | null

Camera MAC address as reported by ONVIF

manufacturerstring | null

Manufacturer reported by ONVIF

modelstring | null

Model reported by ONVIF

namestring | null

Name the camera was (or would be) provisioned with

rtspUrlstring | null

RTSP stream URL derived from ONVIF

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.