You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+64-28Lines changed: 64 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,31 +10,37 @@ There, you will also find examples and detailed instructions on how to use it.
10
10
11
11
Please keep the following in mind when using the UniFi API browser:
12
12
13
-
- The tool does not support all available data collections and API endpoints. See the list below for those currently supported.
14
-
- Currently, versions 5.X.X, 6.X.X, 7.X.X, and 8.X.X of the UniFi Controller software are supported (version **8.5.60** has been confirmed to work)
15
-
- The Network Application on UniFi OS-based controllers is also supported, same versions as above
13
+
- The tool does not support all available data collections and API endpoints. See the list below for those currently
14
+
supported.
15
+
- Currently, versions 5.X.X, 6.X.X, 7.X.X, 8.X.X, and 9.X.X of the UniFi Controller/Networking Application software are
16
+
supported (version **9.4.19** has been confirmed to work)
17
+
- Network Application on UniFi OS-based consoles and servers is also supported, same versions as above
16
18
- When accessing UniFi OS-based controllers through this tool, please read the remarks regarding UniFi OS support
17
19
- Please read the Security Notice before installing this tool.
18
20
19
21
20
22
### Upgrading from 1.x to 2.x
21
23
22
-
Because the structure of the configuration file has changed, we recommend creating a fresh install when upgrading from 1.x to 2.x.
24
+
Because the structure of the configuration file has changed, we recommend creating a fresh install when upgrading from
25
+
1.x to 2.x.
23
26
24
27
25
28
### Features
26
29
27
30
The UniFi API browser tool offers the following features:
28
31
- Browse data collections and API endpoints exposed by the UniFi Controller API in an easy manner
29
32
- Switch between sites managed by the connected controller
30
-
- Switch between output formats (currently **JSON**, **JSON highlighted**, **PHP array**, **interactive**, and **PHP array, highlighted**)
31
-
- Copy the results to clipboard (this is only supported with the JSON output format and will fail gracefully with large collections)
33
+
- Switch between output formats (currently **JSON**, **JSON highlighted**, **PHP array**, **interactive**, and
34
+
**PHP array, highlighted**)
35
+
- Copy the results to clipboard (this is only supported with the JSON output format and will fail gracefully with
36
+
large collections)
32
37
- Switch between the default Bootstrap theme and the [Bootswatch](https://bootswatch.com/) themes
33
38
- An **About** modal that shows version information for PHP, cURL, and the UniFi Controller
34
39
- Very easy setup with minimal dependencies
35
40
- Timing details of API calls can be useful to "benchmark" your UniFi Controller
36
41
- A useful tool when developing applications that make use of the UniFi Controller API
37
-
- The API exposes more data than is visible through the UniFi controller's web interface, making it useful for troubleshooting purposes
42
+
- The API exposes more data than is visible through the UniFi controller's web interface, making it useful for
43
+
troubleshooting purposes
38
44
- Debug mode to troubleshoot cURL connections (set `$debug` to `true` in the config file to enable debug mode)
39
45
40
46
@@ -101,56 +107,75 @@ The UniFi API browser tool offers the following features:
101
107
- list IDS/IPS events
102
108
- list system log entries
103
109
104
-
Please note that the bundled API client supports many more API endpoints, not all make sense to add to the API browser though.
110
+
Please note that the bundled API client supports many more API endpoints, not all make sense to add to the API browser
111
+
though.
105
112
106
113
107
114
### Requirements
108
115
109
116
- A web server with PHP (7.4.0 or higher) and the php-curl module installed
110
-
- Network connectivity between this web server and the server (and port) where the UniFi controller is running (in case you are seeing errors, please check out [this issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/4))
111
-
- Web browsers accessing this tool should have full internet access because several CSS and JS files are loaded from public CDNs.
112
-
- Using an administrator account with **read-only** permissions can limit visibility on certain collection/object properties.
113
-
See this [issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129) and this [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94)
114
-
for an example where the WPA2 password isn't accessible for **read-only** administrator accounts.
117
+
- Network connectivity between this web server and the server (and port) where the UniFi controller is running (in case
118
+
you are seeing errors, please check out [this issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/4))
119
+
- Web browsers accessing this tool should have full internet access because several CSS and JS files are loaded from
120
+
public CDNs.
121
+
- Using an administrator account with **read-only** permissions can limit visibility on certain collection/object
122
+
properties. See this [issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129) and this [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94) for an example where the WPA2 password isn't accessible for
123
+
**read-only** administrator accounts.
115
124
116
125
117
126
### Installation
118
127
119
-
Installation of this tool is quite straightforward. The easiest way to do this is by using `git clone` which also allows for easy updates:
120
-
- open up a terminal window on your server and `cd` to the root folder of your web server (on Ubuntu this is `/var/www/html`) and execute the following command from your command prompt:
128
+
Installation of this tool is quite straightforward. The easiest way to do this is by using `git clone` which also allows
129
+
for easy updates:
130
+
- open up a terminal window on your server and `cd` to the root folder of your web server (on Ubuntu this is
131
+
`/var/www/html`) and execute the following command from your command prompt:
- when git is done cloning, follow the configuration steps below to configure the settings for access to your UniFi Controller's API
135
+
- when git is done cloning, follow the configuration steps below to configure the settings for access to your UniFi
136
+
Controller's API
125
137
126
-
Alternatively, you may choose to download the zip file and unzip it in your directory of choice, then follow the configuration steps below.
138
+
Alternatively, you may choose to download the zip file and unzip it in your directory of choice, then follow the
139
+
configuration steps below.
127
140
128
141
129
142
### Installation using Docker
130
143
131
-
@scyto maintains Docker containers for quick and easy deployment of the UniFi API browser tool. Please refer to [this Wiki page](https://github.com/Art-of-WiFi/UniFi-API-browser/wiki/Docker-Hosting) within the repository for more details. Please note we don't provide support related to Docker-based installs.
144
+
@scyto maintains Docker containers for quick and easy deployment of the UniFi API browser tool. Please refer to
145
+
[this Wiki page](https://github.com/Art-of-WiFi/UniFi-API-browser/wiki/Docker-Hosting) within the repository for more details. Please note we don't provide support related to
146
+
Docker-based installs.
132
147
133
148
134
149
### Configuration
135
150
136
-
- Credentials for access to the UniFi Controller API are configured in the file named `config/config-template.php` which should be copied/renamed to `config/config.php`
137
-
- Starting with version 1.0.3, you can store **multiple controller configurations** in an array inside the `config/config.php` file
151
+
- Credentials for access to the UniFi Controller API are configured in the file named `config/config-template.php` which
152
+
should be copied/renamed to `config/config.php`
153
+
- Starting with version 1.0.3, you can store **multiple controller configurations** in an array inside the
154
+
`config/config.php` file
138
155
- Please refer to the `config/config-template.php` file for further configuration instructions
139
-
- Starting with API browser tool version 2.0.0, you can restrict access to the tool by creating user accounts and passwords. Please refer to the instructions in the `config/users-template.php` file for further details
140
-
- After following these steps, you can open the tool in your browser (assuming you installed it in the root folder of your web server as suggested above) by going to this url: `http(s)://<server IP address>/UniFi-API-browser/`
156
+
- Starting with API browser tool version 2.0.0, you can restrict access to the tool by creating user accounts and
157
+
passwords. Please refer to the instructions in the `config/users-template.php` file for further details
158
+
- After following these steps, you can open the tool in your browser (assuming you installed it in the root folder of
159
+
your web server as suggested above) by going to this url: `http(s)://<server IP address>/UniFi-API-browser/`
141
160
142
161
143
162
### UniFi OS support
144
163
145
-
Support for UniFi OS-based controllers (for example, the UniFi Dream Machine Pro) has been added with version 2.0.7. When adding the details for a UniFi OS device to the `config/config.php` file, please make sure not to add a port suffix or trailing slashes to the URL.
164
+
Support for UniFi OS-based controllers (for example, the UniFi Dream Machine Pro or UniFi OS Server) has been added with
165
+
version 2.0.7. When adding the details for a UniFi OS console to the `config/config.php` file, please make sure not to
166
+
add trailing slashes to the URL. For UniFi OS Consoles (e.g., UDM PRO) use port 443 for the connection.
146
167
147
-
When using the UniFi API browser to connect to a Network Application on a UniFi OS-based gateway via the WAN interface, it is necessary to create a specific firewall rule to allow external access to port 443 on the gateway's local interface. For more information, please refer to the following blog post for further details:
168
+
When using the UniFi API browser to connect to a Network Application on a UniFi OS-based gateway via the WAN interface,
169
+
it is necessary to create a specific firewall rule to allow external access to port 443 on the gateway's local
170
+
interface. For more information, please refer to the following blog post for further details:
When connecting to a **UniFi OS Server**, make sure to use port **11443** for the connection.
150
174
151
175
### Extending the Collections dropdown menu
152
176
153
-
Since version 2.0.0 you can extend the Collections dropdown menu with your own options by adding them to the `config.php` file.
177
+
Since version 2.0.0 you can extend the Collections dropdown menu with your own options by adding them to the
178
+
`config.php` file.
154
179
155
180
Here's an example:
156
181
```php
@@ -202,9 +227,11 @@ This is what the result looks like for the above example:
202
227
203
228
### Updates
204
229
205
-
If you installed the tool using the `git clone` command, you can apply updates by going into the directory where the tool is installed, and running the `git pull` command from there.
230
+
If you installed the tool using the `git clone` command, you can apply updates by going into the directory where the
231
+
tool is installed, and running the `git pull` command from there.
206
232
207
-
Otherwise, you can simply copy the contents from the latest [zip file](https://github.com/Art-of-WiFi/UniFi-API-browser/archive/master.zip) to the directory where the tool has been installed.
233
+
Otherwise, you can simply copy the contents from the latest [zip file](https://github.com/Art-of-WiFi/UniFi-API-browser/archive/master.zip) to the directory where the tool has been
234
+
installed.
208
235
209
236
210
237
### Credits
@@ -240,7 +267,10 @@ Other included libraries:
240
267
241
268
242
269
### Support and Feedback
243
-
This project is actively maintained, and feedback and suggestions are always welcome. If you encounter any issues or have any suggestions for improvements, please use the GitHub [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues) list or the Ubiquiti Community forums (https://community.ubnt.com/t5/UniFi-Wireless/UniFi-API-browser-tool-released/m-p/1392651) to share your ideas and questions.
270
+
This project is actively maintained, and feedback and suggestions are always welcome. If you encounter any issues or
271
+
have any suggestions for improvements, please use the GitHub [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues) list or the Ubiquiti Community forums
272
+
(https://community.ubnt.com/t5/UniFi-Wireless/UniFi-API-browser-tool-released/m-p/1392651) to share your ideas and
273
+
questions.
244
274
245
275
246
276
### Screenshots
@@ -274,3 +304,9 @@ Showing the site settings collection in interactive PHP format:
0 commit comments