Comprehensive, unofficial REST API documentation for UniFi Dream Machine Reverse-engineered through systematic testing and analysis.
This repository contains comprehensive documentation for the UniFi Dream Machine (UDM/UDM Pro) REST API. This documentation enables programmatic management of your UniFi network infrastructure.
- ✅ V1 REST API - 42 endpoints for traditional UniFi features
- ✅ V2 API - 14 endpoints for modern features (DNS records, traffic rules, firewall zones, QoS)
- ✅ Network management including VLANs, DHCP, DNS, routing, and VPN
- ✅ Device management for UniFi devices (reboot, adopt, upgrade)
- ✅ Firewall rules and port forwarding
- ✅ WiFi (WLAN) configuration
- ✅ Client management (block, unblock, kick, guest authorization)
- ✅ System administration (backup, restore, site management, admin users)
- ✅ Monitoring & statistics including dashboard, clients, DPI, and historical reports
- ✅ Authentication via API keys
- Log in to UniFi Network UI
- Navigate to Settings → Admins
- Select your admin account
- Click "Create API Token"
- Copy and save the token securely
V1 REST API Example:
curl -k -H "X-Api-Key: <YOUR_API_KEY>" \
"https://<UDM_IP>/proxy/network/api/s/default/stat/device"V2 API Example:
curl -k -H "X-Api-Key: <YOUR_API_KEY>" \
"https://<UDM_IP>/proxy/network/v2/api/site/default/static-dns"- API Reference Overview - Complete API reference with authentication and common notes
- API V1 REST Reference - 42 V1 REST API endpoints
- API V2 Reference - 14 V2 API endpoints
- Quick Start Guide - Get up and running in 5 minutes
| API Version | Endpoints | Description |
|---|---|---|
| V1 REST | 42 | Traditional UniFi features (networks, WiFi, firewall, VPN, system management) |
| V2 | 14 | Modern features (DNS records, traffic rules, firewall zones, QoS) |
| Total | 56 | Comprehensive API coverage |
| Category | Endpoints | Features |
|---|---|---|
| Network | 13 | Networks, WiFi, routing, port forwarding, VPN servers/clients, DHCP/DNS |
| Security | 3 | Firewall rules, firewall groups, RADIUS profiles |
| Monitoring | 11 | Events, alarms, DPI, dashboard, health, clients, statistics/reports |
| System | 15 | Devices, settings, backup/restore, site management, admin users, client/device commands |
| Category | Endpoints | Features |
|---|---|---|
| Network | 6 | DNS records, traffic rules, NAT, topology, AP groups, QoS rules |
| Security | 4 | Firewall zones, zone matrix, zone policies, IP groups |
| Monitoring | 2 | Alerts, notifications |
| System | 2 | Devices, feature flags |
- 56 documented endpoints across V1 and V2 APIs
- Clean reference format - API-only documentation, no verbose explanations
- Full CRUD coverage - All HTTP methods documented where applicable
- Organized by category - Core, Network, Security, Monitoring, System
- Production ready - All endpoints tested and verified
- Comprehensive field documentation - Detailed parameter descriptions with types and defaults
- DNS Management - Programmatically manage custom DNS records (V2 API)
- Network Automation - Manage VLANs, subnets, routing, and traffic rules
- VPN Management - Configure VPN servers, generate client profiles, monitor connections
- Firewall Management - Configure firewall zones, rules, and policies
- Device Management - Monitor, configure, reboot, adopt, and upgrade UniFi devices
- Client Management - Block/unblock clients, authorize guests, force reconnects
- System Administration - Backup/restore configuration, manage sites and admin users
- QoS & Traffic Shaping - Prioritize network traffic with QoS rules
- Monitoring & Analytics - Access system events, alerts, and historical statistics
- Integration - Integrate UDM with automation platforms and custom applications
This is unofficial documentation created through reverse-engineering. It is not endorsed by or affiliated with Ubiquiti Inc. Use at your own risk. Always backup your configuration before making changes.
MIT License - See LICENSE file for details
Contributions welcome! See CONTRIBUTING.md for guidelines.
- UniFi community for sharing knowledge
- Ubiquiti for creating great networking hardware
Note: This documentation covers both V1 REST API and V2 API endpoints. All endpoints require API key authentication via the X-Api-Key header.