unifi-network

Manage UniFi Network devices, clients, WLANs, firewall rules, and more via the local Network application API.

Package Information

Released: 5 mo ago
Downloads: 8 weekly / 149 monthly
Latest Version: 0.1.0
Author: AvantGuard LLC

Available Nodes

Documentation generating…

UniFi Network icon
UniFi Network
Manage UniFi Network devices, clients, WLANs, firewall rules, and more via the local Network application API.

Documentation

n8n      AvantGuard

UniFi Network n8n Node

n8n community node npm

Manage UniFi Network devices, clients, WLANs, firewall rules, and more via the local Network application API.

Table of Contents

Installation

Follow the n8n community node installation guide.

Or install directly via npm:

npm install @avantguardllc/n8n-nodes-unifinetwork

Authentication

This node authenticates using an API Key.

Setting Value
Type API Key
Base URL https://{{$credentials.host}}/proxy/network (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/network

SiteStats

Endpoint Description
🔵 GET /api/s/{site}/stat/health Get Site Health

Devices

Endpoint Description
🔵 GET /api/s/{site}/stat/device List Devices
🔵 GET /v1/sites/{siteId}/devices List Devices (Official API v1)

Clients

Endpoint Description
🔵 GET /api/s/{site}/stat/sta List Active Clients
🔵 GET /api/s/{site}/rest/user List All Known Clients
🟢 POST /api/s/{site}/cmd/stamgr Execute Client Command
🔵 GET /v1/sites/{siteId}/clients List Connected Clients (Official API v1)

WLANs

Endpoint Description
🔵 GET /api/s/{site}/rest/wlanconf List WLANs
🟢 POST /api/s/{site}/rest/wlanconf Create WLAN
🟡 PUT /api/s/{site}/rest/wlanconf/{id} Update WLAN
🔴 DELETE /api/s/{site}/rest/wlanconf/{id} Delete WLAN

Networks

Endpoint Description
🔵 GET /api/s/{site}/rest/networkconf List Networks

Firewall

Endpoint Description
🔵 GET /api/s/{site}/rest/firewallrule List Firewall Rules

SwitchPorts

Endpoint Description
🔵 GET /api/s/{site}/rest/portconf List Port Profiles

DeviceManagement

Endpoint Description
🟢 POST /api/s/{site}/cmd/devmgr Execute Device Command

EventsAlarms

Endpoint Description
🔵 GET /api/s/{site}/stat/event List Events
🔵 GET /api/s/{site}/stat/alarm List Alarms

Sites

Endpoint Description
🔵 GET /api/self/sites List Sites

Compatibility

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

License

MIT

Discussion