---
title: "Get NVR details"
method: GET
path: "/v1/nvrs"
tags: ["NVR information & management"]
---

# Get NVR details

`GET /v1/nvrs`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration/v1/nvrs`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/nvrs/get.ts> (a function with typed inputs; its response is checked against the schema)

Get detailed information about the NVR

## Response `200`

Success response

- Nvr
  - `id` string, required: The primary key of nvr
  - `modelKey` 'nvr', required: The model key of the nvr
  - `name` string, required: The name of the device.
  - `doorbellSettings` DoorbellSettings, required
    - `defaultMessageText` string: Default text to display on the LCD screen.
    - `defaultMessageResetTimeoutMs` number: Default timeout for resetting LCD screen to the default message.
    - `customMessages` string[]: A list of custom doorbell messages.
    - `customImages` object[]: A list of custom doorbell images for client preview.
      - `preview` string, required
      - `sprite` string, required
  - `armMode` NvrArmMode, required
    - `status` 'arming' | 'armed' | 'breach' | 'disabled', required
    - `armProfileId` string, nullable, required
    - `armedAt` number, nullable, required
    - `willBeArmedAt` number, nullable, required
    - `breachDetectedAt` number, nullable, required
    - `breachEventCount` number, required
    - `breachTriggerEventId` string, nullable, required
    - `breachEventId` string, nullable, required

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-protect-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/revisions/e341e1381db1?raw)