Relay Webservice

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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/relay/addThirdPartyCameraViaOnvif
  • 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

autoAssignboolean nullable

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

ipAddressstring nullable

IPv4 address of the camera to probe

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

namestring nullable

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

nvrUuidstring RUUID nullable

base 64 (url-safe) uuid string

passwordstring nullable

ONVIF password to try first (optional)

trySavedCredentialsboolean nullable

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

usernamestring nullable

ONVIF username to try first (optional)

Example request

{
  "ipAddress": "10.5.4.20",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "nvrUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

assignedDeviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

assignmentMsgstring nullable

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

codecstring nullable

Detected codec(s)

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
foundboolean nullable

Whether an ONVIF-streamable camera was found at the address

ipAddressstring nullable

Resolved camera IP address

macAddressstring nullable

Camera MAC address as reported by ONVIF

manufacturerstring nullable

Manufacturer reported by ONVIF

modelstring nullable

Model reported by ONVIF

namestring nullable

Name the camera was (or would be) provisioned with

rtspUrlstring nullable

RTSP stream URL derived from ONVIF

warningMsgstring nullable

Example response

{
  "assignedDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

Changes

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