VEverdun
nvrs

Create Nvr

post/sites/{site_id}/nvrs

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sites/{site_id}/nvrs
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Request body

namestring required

Display name for this NVR.

kind'dw_spectrum' | 'milestone_xprotect' | 'hikvision'
hoststring required

Hostname or IP of the NVR's media server (DW Spectrum / Nx), Open Network Bridge (Milestone XProtect), or ISAPI web server (Hikvision / LTS / HiLook).

portstring nullable

Control port Verdun connects to. Vendor-specific — omit to use the vendor default: 7001 for DW Spectrum / Nx (media server: REST API + RTSP relay), 580 for Milestone XProtect (Open Network Bridge ONVIF port; RTSP on 554 is discovered via GetStreamUri, not configured here), 80 for Hikvision / LTS / HiLook (ISAPI HTTP port; 443 and 8443 are treated as HTTPS).

rtsp_portstring nullable

Hikvision / LTS / HiLook only: the TCP port Verdun reaches the NVR's RTSP service on from outside the site (often 554; sites that port-forward may use another, e.g. 8554). Omit for 554. Ignored, and not stored, for other NVR kinds.

usernamestring required

NVR service-account username.

passwordstring required

NVR service-account password (stored in Secrets Manager only).

Example request

{
  "name": "Warehouse DW Spectrum",
  "host": "64.183.7.186",
  "port": "7001",
  "rtsp_port": "554",
  "username": "verdun-service",
  "password": "<PASSWORD>"
}

Response

Successful Response

idstring uuid required

The NVR record ID.

site_idstring uuid required

The site this NVR belongs to.

namestring required

Display name for this NVR.

kind'dw_spectrum' | 'milestone_xprotect' | 'hikvision' required
hoststring required

Hostname or IP of the NVR's media server (DW Spectrum / Nx), Open Network Bridge (Milestone XProtect), or ISAPI web server (Hikvision / LTS / HiLook).

portstring required

Control port Verdun connects to (7001 DW Spectrum / Nx media server, 580 Milestone Open Network Bridge ONVIF port, 80 Hikvision ISAPI HTTP port by default).

rtsp_portstring nullable

Hikvision / LTS / HiLook only: the RTSP port Verdun streams from (separate from port). Null for other NVR kinds.

usernamestring required

NVR service-account username (password is never returned).

api_versionstring nullable

Protocol negotiated at last login: the Nx REST API version (v3 / v2) for DW Spectrum / Nx, onvif for Milestone XProtect, or isapi for Hikvision.

last_synced_atstring date-time nullable

Last successful device enumeration.

Example response

{
  "name": "Warehouse DW Spectrum",
  "host": "64.183.7.186",
  "port": "7001",
  "rtsp_port": "554",
  "username": "verdun-service",
  "api_version": "v3"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.