unifi-protect

Manage UniFi Protect cameras, events, liveviews, sensors, lights, and viewers via the local NVR API.

Package Information

Downloads: 3 weekly / 127 monthly
Latest Version: 0.1.0
Author: AvantGuard LLC

Available Nodes

UniFi Protect icon
UniFi Protect
Manage UniFi Protect cameras, events, liveviews, sensors, lights, and viewers via the local NVR API.

Documentation

n8n      AvantGuard

UniFi Protect n8n Node

n8n community node npm

Manage UniFi Protect cameras, events, liveviews, sensors, lights, and viewers via the local NVR API.

Table of Contents

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-unifiprotect

Authentication

This node authenticates using an API Key.

Setting Value
Type API Key
Base URL https://{{$credentials.host}}/proxy/protect (editable in credentials)

Tip: The Base URL can be changed in the credential settings if your instance uses a different host.

Resources & Operations

Base URL: https://{{$credentials.host}}/proxy/protect

Bootstrap

Endpoint Description
🔵 GET /proxy/protect/api/bootstrap Get Bootstrap

NVR

Endpoint Description
🔵 GET /proxy/protect/api/nvr Get NVR Info

Cameras

Endpoint Description
🔵 GET /proxy/protect/api/cameras List Cameras
🔵 GET /proxy/protect/api/cameras/{cameraId} Get Camera by ID
🟣 PATCH /proxy/protect/api/cameras/{cameraId} Update Camera
🔵 GET /proxy/protect/api/cameras/{cameraId}/snapshot Get Camera Snapshot

Events

Endpoint Description
🔵 GET /proxy/protect/api/events List Events
🔵 GET /proxy/protect/api/events/{eventId}/thumbnail Get Event Thumbnail

Recordings

Endpoint Description
🔵 GET /proxy/protect/api/video/export Export Video Recording

Liveviews

Endpoint Description
🔵 GET /proxy/protect/api/liveviews List Liveviews

Sensors

Endpoint Description
🔵 GET /proxy/protect/api/sensors List Sensors

Lights

Endpoint Description
🔵 GET /proxy/protect/api/lights List Lights

Viewers

Endpoint Description
🔵 GET /proxy/protect/api/viewers List Viewers

Compatibility

  • n8n version: 1.0+ (tested on 2.x)
  • Node.js version: 18+

License

MIT

Discussion