Skip to content

Commit 355e81b

Browse files
committed
executed composer update
addresses PR #100 from @dependabot
1 parent 39aa18d commit 355e81b

File tree

12 files changed

+198
-151
lines changed

12 files changed

+198
-151
lines changed

composer.lock

Lines changed: 26 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vendor/art-of-wifi/unifi-api-client/README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API.
44

5-
UniFi Network Controller software versions 4.X.X, 5.X.X and 6.X.X are supported as well as UniFi OS-based controllers (version 6.5.55 has been confirmed to work).
6-
This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
5+
UniFi Network Controller software versions 4.X.X, 5.X.X, 6.X.X, and 7.X.X (version 7.0.23 has been confirmed to work)
6+
are supported as well as UniFi OS-based controllers. This class is used by our API browser tool which can be found
7+
[here](https://github.com/Art-of-WiFi/UniFi-API-browser).
78

89
The package can be installed manually or by using
910
composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for
@@ -15,20 +16,23 @@ easy inclusion in your projects.
1516
- PHP 5.5.0 or higher
1617
- PHP json and PHP cURL modules
1718
- tested on Apache 2.4 with PHP 5.6.1 and cURL 7.42.1 and with PHP 7.4.9 and cURL 7.68.0
18-
- direct network connectivity between this server and the host and port (normally TCP port 8443 or port 443 for
19+
- direct network connectivity between this server and the host and port (usually TCP port 8443 or port 443 for
1920
UniFi OS) where the UniFi Controller is running
20-
- you must use **accounts with local access**, not pure UniFi Cloud accounts, to access the UniFi Controller API through
21-
this class
21+
- you must use **accounts with local access**, not UniFi Cloud accounts, to access the UniFi Controller API
22+
through this class
2223

2324
## UniFi OS Support
2425

25-
Support for UniFi OS-based controllers (UniFi Dream Router, UniFi Dream Machine, UniFi Dream Machine Pro
26-
or Cloud Key Gen2/Cloud Key Gen2 Plus with firmware version 2.0.24 or higher) has
27-
been added as of version 1.1.47. The class automatically detects UniFi OS devices and
28-
adjusts URLs and several functions/methods accordingly. If your own code implements strict
29-
validation of the URL that is passed to the constructor, please adapt your logic to
30-
allow URLs without a port suffix or with port 443 when dealing with a UniFi OS-based
31-
controller.
26+
Support for UniFi OS-based controllers has been added as of version 1.1.47:
27+
- UniFi Dream Router (UDR)
28+
- UniFi Dream Machine (UDM)
29+
- UniFi Dream Machine Pro (UDM PRO)
30+
- Cloud Key Gen2 (UCK G2), firmware version 2.0.24 or higher
31+
- Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
32+
33+
The class automatically detects UniFi OS-based controllers and adjusts URLs and several functions/methods accordingly.
34+
If your own code implements strict validation of the URL that is passed to the constructor, please adapt your
35+
logic to allow URLs without a port suffix or with port 443 when working with a UniFi OS-based controller.
3236

3337
Please test all methods you plan on using thoroughly before using the API Client with
3438
UniFi OS devices in a production environment.
@@ -128,9 +132,10 @@ own PHP code.
128132
associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
129133

130134
3. Using an administrator account (`$controller_user` in the above example) with **read-only** permissions can limit
131-
visibility on certain collection/object properties. See this [issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129)
132-
and this [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94) for an example where the WPA2 password
133-
isn't accessible for **read-only** administrator accounts.
135+
visibility on certain collection/object properties. See this
136+
[issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129) and this
137+
[issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94) for an example where the WPA2 password isn't
138+
visible for **read-only** administrator accounts.
134139

135140
## Functions/methods supported
136141

@@ -347,7 +352,7 @@ This class is based on the initial work by the following developers:
347352

348353
and the API as published by Ubiquiti:
349354

350-
- https://dl.ui.com/unifi/6.5.55/unifi_sh_api
355+
- https://dl.ui.com/unifi/7.0.23/unifi_sh_api
351356

352357
## Important Disclaimer
353358

0 commit comments

Comments
 (0)