Ubiquiti

UniFi Network Controller API

The UniFi Network Controller API is the local HTTP API exposed by every UniFi Network controller (UDM, UDM Pro, UDR, Cloud Key, self-hosted controller, UniFi OS consoles). Endpoints are prefixed with `/api/s/{site}/` on a standalone controller, or `/proxy/network/api/s/{site}/` on UniFi OS devices. It covers sites, devices, clients, stats (`stat/health`, `stat/sta`, `stat/device`), settings, wireless networks, firewall, port forwards, vouchers, hotspot, alerts, and events. Authentication is via `/api/auth/login` on UniFi OS. Responses follow the `{ "meta": { "rc": "ok" }, "data": [...] }` shape. Not formally documented by Ubiquiti; reverse-engineered conventions captured in community wikis and third-party SDKs.

GitHub

Documentation

📖
Documentation
https://ubntwiki.com/products/software/unifi-controller/api
📖
Documentation
https://help.ui.com/hc/en-us/articles/30076656117655-Getting-Started-with-the-Official-UniFi-API
📖
Documentation
https://github.com/ubiquiti-community/unifi-api

SDKs

📦
SDK
https://github.com/Art-of-WiFi/UniFi-API-client

API entry from apis.yml

apis.yml Raw ↑ 
aid: ubiquiti:unifi-network-controller-api
name: UniFi Network Controller API
tags:
- Networking
- UniFi
- Controller
- Local API
humanURL: https://ubntwiki.com/products/software/unifi-controller/api
properties:
- url: https://ubntwiki.com/products/software/unifi-controller/api
  type: Documentation
- url: https://help.ui.com/hc/en-us/articles/30076656117655-Getting-Started-with-the-Official-UniFi-API
  type: Documentation
- url: https://github.com/Art-of-WiFi/UniFi-API-client
  type: SDK
- url: https://github.com/ubiquiti-community/unifi-api
  type: Documentation
description: 'The UniFi Network Controller API is the local HTTP API exposed by every UniFi Network controller
  (UDM, UDM Pro, UDR, Cloud Key, self-hosted controller, UniFi OS consoles). Endpoints are prefixed with
  `/api/s/{site}/` on a standalone controller, or `/proxy/network/api/s/{site}/` on UniFi OS devices.
  It covers sites, devices, clients, stats (`stat/health`, `stat/sta`, `stat/device`), settings, wireless
  networks, firewall, port forwards, vouchers, hotspot, alerts, and events. Authentication is via `/api/auth/login`
  on UniFi OS. Responses follow the `{ "meta": { "rc": "ok" }, "data": [...] }` shape. Not formally documented
  by Ubiquiti; reverse-engineered conventions captured in community wikis and third-party SDKs.'