UniFi-API-Browser

UniFi-API-Browser

Docker app from Ahmad's Repository

Overview

The API Browser lets you pull raw, JSON formatted data from the API running on your UniFi Controller.

Connecting to Multiple UniFi Controllers:

Unifi-API-Browser supports multiple controllers. To use them create a copy of 'users-tempalte.php' and 'config-template.php' and mount them as volumes at '/app/config/config.php' & '/app/config/users.php'

Runtime arguments

Web UI
http://[IP]:[PORT:8000]
Network
bridge
Privileged
false

Template configuration

UI PortPorttcp
Target
8000
Default
8080
Value
8002
UniFi Controller UsernameVariable

the user name for access to the Unifi Controller. NOTE: use a 'Local Access' account, not a 'Ubiquiti Account'.

Target
CONTROLLER_USER
UniFi Controller PasswordVariable

the password for access to the Unifi Controller

Target
CONTROLLER_PASS
UniFi Controller IPVariable

IP address of the Unifi Controller

Target
CONTROLLER_IP
UniFi Controller PortVariable

Port if you changed the port UniFi is running on

Target
CONTROLLER_PORT
Default
443
UniFi Controller NameVariable

name for this controller which will be used in the dropdown menu

Target
CONTROLLER_NAME
Default
UniFi Controller
Enable Debug LoggingVariable

set to 'true' (without quotes) to enable debug output to the browser and the PHP error log when fetching the sites collection after selecting a controller

Target
DEBUG
Default
false
UI AuthenticationVariable

enable/disable authentication

Target
UI_AUTH
Default
false
UI Auth UsernameVariable

username to secure the API Browser instance

Target
UI_USER
Default
admin
UI Auth PasswordVariable

Generate a SHA512 of the password you want and put here, you can use a tool like https://sha512.online/ by default the password is 'admin'

Target
UI_PASS
Default
c7ad44cbad762a5da0a452f9e854fdc1e0e7a52a38015f23f3eab1d80b931dd472634dfac71cd34ebc35d16ab7fb8a90c81f975113d6c7538dc69dd8de9077ec
UI ThemeVariable

your default theme of choice, pick one from the following list: bootstrap, cerulean, cosmo, cyborg, darkly, flatly, journal, lumen, paper readable, sandstone, simplex, slate, spacelab, superhero, united, yeti

Target
UI_THEME
Default
darkly
UI Navbar ClassVariable

class for the main navigation bar, valid options are: light, dark

Target
UI_NAVBAR_CLASS
Default
dark
UI Navbar Background ClassVariable

class for the main navigation bar background, valid options are: primary, secondary, success, danger, warning, info, light, dark, white, transparent

Target
UI_NAVBAR_BG_CLASS
Default
dark

Download Statistics

3,732
Total Downloads

Details

Repository
ahmadnassri/unifi-api-browser
Last Updated2025-12-04
First Seen2022-08-28

Run UniFi-API-Browser on Unraid.

UniFi-API-Browser is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.