Skip to main content
POST
Add third party camera via ONVIF

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

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

autoAssign
boolean | null

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

ipAddress
string | null

IPv4 address of the camera to probe

Example:

"10.5.4.20"

locationUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

name
string | null

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

nvrUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

password
string | null

ONVIF password to try first (optional)

trySavedCredentials
boolean | null

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

username
string | null

ONVIF username to try first (optional)

Response

200 - application/json

OK

Result of adding a third-party camera via ONVIF.

assignedDeviceUuid
string<DeviceFacetUuid> | null
DeviceFacetUuid

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

assignmentMsg
string | null

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

codec
string | null

Detected codec(s)

error
boolean | null
errorMsg
string | null
found
boolean | null

Whether an ONVIF-streamable camera was found at the address

ipAddress
string | null

Resolved camera IP address

macAddress
string | null

Camera MAC address as reported by ONVIF

manufacturer
string | null

Manufacturer reported by ONVIF

model
string | null

Model reported by ONVIF

name
string | null

Name the camera was (or would be) provisioned with

rtspUrl
string | null

RTSP stream URL derived from ONVIF

warningMsg
string | null
Last modified on August 11, 2026