COcoram
nvrs

List NVR metrics

Changed on

Returns current aggregate CPU utilization for authorized NVRs in UUID order. Requires read:* scope and at least LIVE_ONLY surveillance access. Full-access users see every tenant-owned NVR, including devices without a location. Restricted users see NVRs at their allowed locations or camera-group locations. CPU uses the Grafana five-minute rate calculation across available modes, excluding idle and I/O-wait from the numerator. Invalid, stale or unavailable telemetry is null; required database failures fail the request. Unknown or inaccessible NVR identifiers return an empty collection. Pagination is not a snapshot across inventory changes. Clients must tolerate additive fields.

get/v1/nvrs/metrics

Request

  • Base URL
    https://developer.coram.ai
  • URL
    https://developer.coram.ai/v1/nvrs/metrics
  • Auth
    API key in header X-Auth-Token

Query parameters

pageinteger

One-based page number. Offset overflow is rejected.

limitinteger
nvrstring

Exact NVR identifier, applied before pagination. Empty is treated as absent.

Headers

X-Tenant-Userstring

Required for privileged global:read keys; the email of a user whose surveillance tenant access determines the target org.

X-Tenant-Orgstring

Optional org selection with X-Tenant-User and global:read. The named user's surveillance access to this org is verified.

Response

Authorized NVR metrics page.

has_moreboolean required

True if another page of results is available.

Changes