Skip to main content
POST
Get third party camera discovery scan status

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 getting the progress of the current/most-recent third-party camera discovery run in the organization.

Response

200 - application/json

OK

Progress of the current/most-recent third-party camera discovery run.

camerasFound
integer<int32> | null
int32

Number of cameras discovered so far in this run.

error
boolean | null
errorMsg
string | null
hasRun
boolean | null

Whether discovery has ever been run for this org. When false, all other fields are unset/zero.

inProgress
boolean | null

Whether a discovery run is still in progress (at least one Relay scan outstanding and the run is not stale).

nvrCount
integer<int32> | null
int32

Total number of Relays (NVRs) this run is scanning.

nvrProgress
object[] | null

Per-Relay live scan progress and per-IP probe results (for troubleshooting).

pendingCount
integer<int32> | null
int32

Number of Relays whose scan has not yet finished. Zero means the run is complete.

scanId
string | null

Opaque id of the run, so clients can tell if a newer run superseded theirs.

startedMs
integer<int64> | null
int64

Epoch millis when the run started.

warningMsg
string | null
Last modified on August 25, 2026