Relay Webservice

Execute third party camera discovery

Trigger a discovery of cameras on the local LANs

post/api/relay/executeThirdPartyCameraDiscovery

Request

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

additionalScanCidrsstring[] nullable

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.

deviceFilterstring[] nullable

Set of device UUIDs to filter discovery by

locationFilterstring[] nullable

Set of location UUIDs to filter discovery by

Example request

{
  "deviceFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "locationFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}

Response

OK

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

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

warningMsgstring nullable

Changes

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