Cameras API

The NVR Cameras API lists all cameras directly attached to the accessed NVR.

The Camera object

Attributes

Camera plus optional live session info

bitratenumber · double · nullableOptional

idstringRequired

urlstring · uriRequired

server_idstringRequired

usernamestring · nullableOptional

passwordstring · nullableOptional

namestringRequired

descriptionstring · nullableOptional

tagsstring[]Optional

modelstringRequired

recording_ttlintegerRequired

Seconds to keep recordings

failedstring · nullableOptional

createdstring · date-timeRequired

recordingbooleanRequired

inferencingbooleanRequired

enabledbooleanRequired

persistencebooleanRequired

ai_enabledbooleanRequired

location_idinteger · nullableOptional

audioboolean · nullableOptional

record_startstring · time · nullableOptional

record_endstring · time · nullableOptional

supports_ptzboolean · nullableOptional

mac_addressstring · nullableOptional

last_ipstring · nullableOptional

direct_connectedboolean · nullableOptional

redundancyinteger · min: 1Required

Number of redundant streams

The Camera object

{
  "session": {
    "id": 1,
    "camera_id": "text",
    "width": 1,
    "height": 1,
    "frame_nr": 1,
    "frame_dr": 1,
    "clock_rate": 1,
    "codec": "text",
    "audio_codec": "text"
  },
  "bitrate": 1,
  "id": "text",
  "url": "https://example.com",
  "server_id": "text",
  "username": "text",
  "password": "text",
  "name": "text",
  "description": "text",
  "tags": [
    "text"
  ],
  "model": "text",
  "recording_ttl": 1,
  "failed": "text",
  "created": "2026-03-11T09:48:07.030Z",
  "recording": true,
  "inferencing": true,
  "enabled": true,
  "persistence": true,
  "ai_enabled": true,
  "location_id": 1,
  "audio": true,
  "record_start": "09:48:07",
  "record_end": "09:48:07",
  "supports_ptz": true,
  "mac_address": "text",
  "last_ip": "text",
  "direct_connected": true,
  "redundancy": 1
}