Skip to main content
POST
Execute third party camera discovery

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 executing third-party camera discovery.

additionalScanCidrs
(string | null)[] | null

Optional list of additional IPv4 CIDRs (e.g. "10.5.0.0/24") to scan for cameras on routed subnets that the NVR is not directly attached to. When empty (the default), discovery only covers the NVR's own directly-attached subnets. Multicast/WS-Discovery cannot cross routers, so these subnets are covered by an RTSP port scan followed by unicast ONVIF probes. At most 8 entries, each /16 or smaller.

Optional list of additional IPv4 CIDRs (e.g. "10.5.0.0/24") to scan for cameras on routed subnets that the NVR is not directly attached to. When empty (the default), discovery only covers the NVR's own directly-attached subnets. Multicast/WS-Discovery cannot cross routers, so these subnets are covered by an RTSP port scan followed by unicast ONVIF probes. At most 8 entries, each /16 or smaller.

deviceFilter
(string<RUUID> | null)[] | null

Set of device UUIDs to filter discovery by

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

locationFilter
(string<RUUID> | null)[] | null

Set of location UUIDs to filter discovery by

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for executing third-party camera discovery.

error
boolean | null
errorMsg
string | null
scanId
string | null

Id of the discovery run that was started, for polling progress via getThirdPartyCameraDiscoveryScanStatus. Null if no run was started.

warningMsg
string | null
Last modified on August 19, 2026