Assign third party camera to relay camera

Assign a third party camera to a relay Camera

POST /api/relay/assignThirdPartyCameraToRelayCamera

Assign third party camera to relay camera

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/assignThirdPartyCameraToRelayCamera \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "discoveredCameraMacAddress": "<string>",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Front Door Camera",
  "rtspUrl": "rtsp://192.168.1.100:554/stream1"
}
'

200

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

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

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

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

Body

application/json

Request object for assigning a third-party camera to a relay camera.

discoveredCameraMacAddress · string | null

MAC address of the discovered camera to assign

locationUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

name · string | null

Name for the third-party camera

Example:

"Front Door Camera"

rtspUrl · string | null

RTSP URL for the camera stream

Example:

"rtsp://192.168.1.100:554/stream1"

Response

200 - application/json

OK

Response object for assigning a third-party camera to a relay camera.

deviceUuid · string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

error · boolean | null

errorMsg · string | null

warningMsg · string | null