UniFi

https://help.ui.com/hc/en-us/articles
Admin
Comprehensive documentation for Ubiquiti's UniFi network management platform covering gateways,...
Tokens:416,936
Snippets:3,786
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and start UniFi Network Server service (ace.jar)

Source: https://help.ui.com/hc/en-us/articles/205144550--Legacy-Self-Hosting-a-UniFi-Network-Server-as-a-Windows-Service

Commands to set up UniFi Network Server as a Windows service: navigate to the installation directory, install the service, and start it. Requires an admin Command Prompt and the configured JAVA_HOME and firewall ports.

```batch
cd "%UserProfile%\Ubiquiti UniFi\"
```

```batch
java -jar lib\ace.jar installsvc
```

```batch
java -jar lib\ace.jar startsvc
```

--------------------------------

### Get Clients on a Site: Example Response for GET /v1/sites/{siteId}/clients

Source: https://help.ui.com/hc/en-us/articles/31228198640023-External-Hotspot-API-for-Authorization-Clients

Example response from the GET /v1/sites/{siteId}/clients endpoint. Shows a client with type WIRELESS and access type GUEST with authorized false.

```json
{
  "type": "WIRELESS",
  "id": "clientId",
  "name": "Apple iPad Pro",
  "macAddress": "42:8a:f7:3c:50:b0",
  "access": {
    "type": "GUEST",
    "authorized": false
  }
}
```

--------------------------------

### Get Sites: Example Response for GET /v1/sites

Source: https://help.ui.com/hc/en-us/articles/31228198640023-External-Hotspot-API-for-Authorization-Clients

Example response from the GET /v1/sites endpoint. In the case of a Cloud Gateway, only one response will be returned with the site ID.

```json
[  
  {  
    "id": "siteId",  
    "name": "Site Name"  
  }  
]
```

--------------------------------

### Example Deployment Command with Options

Source: https://help.ui.com/hc/en-us/articles/18750806392343-UID-Enterprise-Bulk-Deploy-UID-Enterprise-Desktop-App

Example command that performs a silent installation, enables automatic update checks, sets the workspace domain to 'acme', sets VPN proxy mode to Global, and enables launch at startup.

```bash
UI_Desktop-v0.49.1.3.msi /quiet CHECK_UPDATE=1 WORKSPACE=acme VPN_PROXY_MODE=1 LAUNCH_AT_STARTUP=1
```

--------------------------------

### Create web server directory on Windows

Source: https://help.ui.com/hc/en-us/articles/360043360253-UniFi-Recovery-Mode

Creates the c:\webserver directory and changes into it for hosting the firmware file.

```bash
mkdir c:\webserver
cd c:\webserver
```

--------------------------------

### Get Authorized Client Information: Example Response for GET /v1/sites/{siteId}/clients/{clientId}

Source: https://help.ui.com/hc/en-us/articles/31228198640023-External-Hotspot-API-for-Authorization-Clients

Example response from the GET /v1/sites/{siteId}/clients/{clientId} endpoint. Shows updated client details including authorization status with timestamp for authorization and expiration.

```json
{
  "access": {
    "authorized": true,
    "authorization": {
      "authorizedAt": "2025-03-19T11:20:44Z",
      "expiresAt": "2025-03-19T13:00:44Z",
      "dataUsageLimitMBytes": 500
    }
  }
}
```

--------------------------------

### PLIST File Example for UID Enterprise Desktop App

Source: https://help.ui.com/hc/en-us/articles/18750806392343-UID-Enterprise-Bulk-Deploy-UID-Enterprise-Desktop-App

Example PLIST file with keys CheckUpdate, VPNProxyMode, and Workspace. Use as a template for creating your own com.ui.uid.desktop.user.preferences.plist file.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CheckUpdate</key>
<false/>
<key>VPNProxyMode</key>
<true/>
<key>Workspace</key>
<string>Your Workspace Domain Here</string>
</dict>
</plist>
```
Tokens:
Raw