- bumped version to 1.1.96

- removed @version tag in docblock as it contained redundant information
- merged #241 which adds a method to download a generated backup, (contributed by @Jacobtims)

.gitignore

@@ -10,4 +10,7 @@
 .phpdoc-md
 
 # ignore XML files
-*.xml
+*.xml
+
+# ignore PHPStorm files
+.idea/*

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016, Art of WiFi
+Copyright (c) 2024, Art of WiFi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,37 +1,91 @@
 ## UniFi Controller API client class
 
-A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API, versions 4.X.X, 5.X.X and 6.0.X of the UniFi Network Controller software are supported (version 6.0.43 has been confirmed to work) as well as UniFi OS-based controllers (version 5.12.59 has been confirmed to work). This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
+A PHP class that provides access to Ubiquiti's [**UniFi Network Application**](https://unifi-network.ui.com/) API.
+
+UniFi Network Application software versions 5.X.X, 6.X.X, 7.X.X, and 8.X.X (version **8.5.2** has been confirmed to
+work) are supported as well as Network Applications on **UniFi OS-based consoles** (UniFi OS **4.0.20** has been
+confirmed to work).
+
+This class is used by our API Browser tool, which can be found
+[here](https://github.com/Art-of-WiFi/UniFi-API-browser).
+
+The package can be installed manually or by using
+composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for
+easy inclusion in your projects.
 
-The package can be installed manually or by using composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for easy inclusion in your projects.
 
 ## Requirements
 
-- a server with PHP, version 5.5.0 or higher, and the PHP cURL module installed (tested on Apache 2.4 with PHP Version 5.6.1 and cURL 7.42.1 and with PHP 7.2.24 and cURL 7.58.0)
+- a server with:
-- direct network connectivity between this server and the host and port (normally TCP port 8443) where the UniFi Controller is running
+  - PHP **7.4.0** or higher (use version [1.1.83](https://github.com/Art-of-WiFi/UniFi-API-client/releases/tag/v1.1.83) 
-- you must use **local accounts**, not UniFi Cloud accounts, to access the UniFi Controller API through this class
+    for PHP 7.3.x and lower)
+  - PHP json and PHP cURL modules
+  - tested on Apache 2.4 with PHP 7.4.27 and cURL 7.60.0 and with PHP 8.3.11 and cURL 7.81.0
+- direct network connectivity between this server and the host and port (usually TCP port 8443 or port 443 for 
+  UniFi OS) where the UniFi Controller is running
+- you **must** use an **account with local access permissions** to access the UniFi Controller API through this class
+- do not use UniFi Cloud accounts and do not enable 2FA for the accounts that you use with this class
 
 
 ## UniFi OS Support
 
-Support for UniFi OS-based controllers (UniFi Dream Machine Pro or Cloud Key Gen2/Cloud Key Gen2 Plus with firmware version 2.0.24 or higher) has been added as of version 1.1.47. The class automatically detects UniFi OS devices and adjusts URLs and several functions/methods accordingly. If your own code applies strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix when dealing with a UniFi OS-based controller.
+Support for UniFi OS-based controllers has been added as of version 1.1.47. These devices have been verified to work:
+- UniFi Dream Router (UDR)
+- UniFi Dream Machine (UDM)
+- UniFi Dream Machine Pro (UDM PRO)
+- UniFi Cloud Key Gen2 (UCK G2), firmware version 2.0.24 or higher
+- UniFi Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
+- UniFi Cloud Console, details [here](https://help.ui.com/hc/en-us/articles/4415364143511)
+- UniFi Express (UX)
+- UniFi Dream Wall (UDW)
+- UniFi Cloud Gateway Ultra (UCG-Ultra)
+- UniFi Enterprise Fortress Gateway (EFG)
+
+The class automatically detects UniFi OS consoles and adjusts the URLs and several functions/methods accordingly.
+
+UniFi OS-based controllers require you to connect using port **443** instead of **8443** which is used for
+"software-based" controllers. If your own code implements strict validation of the URL that is passed to the
+constructor, please adapt your logic to allow URLs without a port suffix or with port 443 when working with a
+UniFi OS-based controller.
+
+
+### Remote API access to UniFi OS-based controllers
+When connecting to a UniFi OS-based gateway through the WAN interface, you need to create a specific firewall rule to
+allow this. See this blog post on the Art of WiFi website for more details:
+https://artofwifi.net/blog/how-to-access-the-unifi-controller-by-wan-ip-or-hostname-on-a-udm-pro
+
+The "custom firewall rule" approach described there is the recommended method.
+
+
+## Upgrading from a previous version
+
+When upgrading from a version before **1.1.84**, please:
+- make sure you are using PHP **7.4** or higher
+- test the client with your code for any breaking changes; the class methods now have strict parameter type hints and 
+  response types which can break your code in certain cases where the wrong type is passed or a different response type
+  is expected back
 
-Please test all methods you plan on using thoroughly before using the API Client with UniFi OS devices in a production environment.
 
 ## Installation
 
-Use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the API client class.
+Use [Composer](#composer), [Git](#git) or simply [Download the Release](#download-the-release) to install the 
+API client class.
+
 
 ### Composer
 
-The preferred installation method is through [composer](https://getcomposer.org). Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have composer installed.
+The preferred installation method is through [composer](https://getcomposer.org). 
+Follow these [installation instructions](https://getcomposer.org/doc/00-intro.md) if you don't have composer
+installed already.
 
-Once composer is installed, simply execute this command from the shell in your project directory:
+Once composer is installed, simply execute this command from the shell in your project
+directory:
 
 ```sh
 composer require art-of-wifi/unifi-api-client
 ```
 
- Or manually add the package to your composer.json file:
+Or manually add the package to your composer.json file:
 
 ```javascript
 {
@@ -41,12 +95,16 @@ composer require art-of-wifi/unifi-api-client
 }
 ```
 
-Finally, be sure to include the autoloader in your code:
+Finally, be sure to include the composer autoloader in your code if your framework doesn't already do this for you:
 
 ```php
+/**
+ * load the class using the composer autoloader
+ */
 require_once 'vendor/autoload.php';
 ```
 
+
 ### Git
 
 Execute the following `git` command from the shell in your project directory:
@@ -58,17 +116,27 @@ git clone https://github.com/Art-of-WiFi/UniFi-API-client.git
 When git is done cloning, include the file containing the class like so in your code:
 
 ```php
+/**
+ * load the class directly instead of using the composer autoloader
+ */
 require_once 'path/to/src/Client.php';
 ```
 
+
 ### Download the Release
 
-If you prefer not to use composer or git, simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), uncompress the zip file, then include the file containing the class in your code like so:
+If you prefer not to use composer or git,
+simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), unpack the zip
+file, then include the file containing the class in your code like so:
 
 ```php
+/**
+ * load the class directly instead of using the composer autoloader
+ */
 require_once 'path/to/src/Client.php';
 ```
 
+
 ## Example usage
 
 A basic example how to use the class:
@@ -80,7 +148,7 @@ A basic example how to use the class:
 require_once 'vendor/autoload.php';
 
 /**
- * initialize the Unifi API connection class, log in to the controller and request the alarms collection
+ * initialize the UniFi API connection class, log in to the controller and request the alarms collection
  * (this example assumes you have already assigned the correct values to the variables used)
  */
 $unifi_connection = new UniFi_API\Client($controller_user, $controller_password, $controller_url, $site_id, $controller_version, true);
@@ -88,47 +156,60 @@ $login            = $unifi_connection->login();
 $results          = $unifi_connection->list_alarms(); // returns a PHP array containing alarm objects
 ```
 
-Please refer to the `examples/` directory for some more detailed examples which can be used as a starting point for your own PHP code.
+Please refer to the `examples/` directory for some more detailed examples which can be used as a starting point for your
+own PHP code.
+
 
 #### IMPORTANT NOTES:
 
-1. In the above example, `$site_id` is the short site "name" (usually 8 characters long) that is visible in the URL when managing the site in the UniFi Network Controller. For example with this URL:
+1. In the above example, `$site_id` is the short site "name" (usually 8 characters long) that is visible in the URL when
+   managing the site in the UniFi Network Controller. For example with this URL:
 
    `https://<controller IP address or FQDN>:8443/manage/site/jl3z2shm/dashboard`
 
    `jl3z2shm` is the short site "name" and the value to assign to $site_id.
 
-2. The last optional parameter that is passed to the constructor in the above example (`true`), enables validation of the controller's SSL certificate which is otherwise **disabled** by default. It is highly recommended to enable this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
+2. The 6th optional parameter that is passed to the constructor in the above example (`true`), enables validation of
+   the controller's SSL certificate which is otherwise **disabled** by default. It is **highly recommended** to enable
+   this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is
+   associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
+
+3. Using an administrator account (`$controller_user` in the above example) with **read-only** permissions can limit 
+   visibility on certain collection/object 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
+   visible for **read-only** administrator accounts.
+
 
 ## Functions/methods supported
 
-The class currently supports the following functions/methods to GET/POST/PUT/DELETE data through the UniFi Controller API. Please refer to the comments in the source code for more details on the functions/methods and their respective parameters.
+The class currently supports the following functions/methods to access the UniFi Controller API. This list is sorted
+alphabetically. Please refer to the comments in the source code for more details on each of the functions/methods,
+their purpose, and their respective parameters.
 
-- login()
-- logout()
 - adopt_device()
+- advanced_adopt_device()
 - archive_alarm()
 - assign_existing_admin()
 - authorize_guest()
 - block_sta()
 - cancel_rolling_upgrade()
-- cmd_stat()
-- count_alarms()
 - check_controller_update()
 - check_firmware_update()
-- create_apgroup() (supported with controller versions 6.0.X and higher)
+- cmd_stat()
+- count_alarms()
+- create_apgroup()
 - create_dynamicdns()
 - create_firewallgroup()
 - create_hotspotop()
 - create_network()
 - create_radius_account()
-- create_site()
 - create_user()
 - create_usergroup()
 - create_voucher()
 - create_wlan()
 - custom_api_request()
-- delete_apgroup() (supported with controller versions 6.0.X and higher)
+- delete_apgroup()
 - delete_device()
 - delete_firewallgroup()
 - delete_network()
@@ -137,26 +218,46 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - delete_usergroup()
 - delete_wlan()
 - disable_ap()
-- edit_apgroup() (supported with controller versions 6.0.X and higher)
+- disable_wlan()
+- edit_apgroup()
 - edit_client_fixedip()
+- edit_client_name()
 - edit_firewallgroup()
 - edit_usergroup()
 - extend_guest_validity()
-- forget_sta() (supported on controller version 5.9.X and higher)
+- forget_sta()
+- generate_backup()
+- generate_backup_site()
+- get_class_version()
+- get_cookie()
+- get_cookies()
+- get_curl_connection_timeout()
+- get_curl_http_version()
+- get_curl_method()
+- get_curl_request_timeout()
+- get_curl_request_timeout()
+- get_curl_ssl_verify_host()
+- get_curl_ssl_verify_peer()
+- get_debug()
+- get_is_unifi_os()
+- get_last_error_message()
+- get_last_results_raw()
+- get_site()
 - invite_admin()
 - led_override()
 - list_admins()
-- list_alarms()
 - list_all_admins()
-- list_apgroups() (supported with controller versions 6.0.X and higher)
+- list_alarms()
-- list_aps() (deprecated but still available as alias)
+- list_aps()
 - list_backups()
 - list_clients()
 - list_country_codes()
 - list_current_channels()
 - list_dashboard()
+- list_device_name_mappings()
+- list_device_states()
 - list_devices()
-- list_dpi_stats()
+- list_devices_basic()
 - list_dynamicdns()
 - list_events()
 - list_extension()
@@ -170,38 +271,46 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - list_portconf()
 - list_portforward_stats()
 - list_portforwarding()
-- list_radius_accounts() (supported on controller version 5.5.19 and higher)
+- list_radius_accounts()
 - list_radius_profiles()
-- list_rogueaps()
-- list_routing()
 - list_self()
 - list_settings()
 - list_sites()
-- list_tags() (supported on controller version 5.5.19 and higher)
+- list_tags()
-- list_usergroups()
 - list_users()
 - list_wlan_groups()
 - list_wlanconf()
 - locate_ap()
+- login()
+- logout()
 - move_device()
 - power_cycle_switch_port()
 - reboot_cloudkey()
-- reconnect_sta()
 - rename_ap()
-- restart_ap() (deprecated but still available as alias)
-- restart_device()
 - revoke_admin()
 - revoke_voucher()
 - set_ap_radiosettings()
+- set_ap_wlangroup()
+- set_connection_timeout()
+- set_cookies()
+- set_curl_http_version()
+- set_curl_request_timeout()
+- set_curl_ssl_verify_host()
+- set_curl_ssl_verify_peer()
+- set_debug()
 - set_device_settings_base()
 - set_dynamicdns()
-- set_element_adoption() (supported on controller version 5.13.X and higher)
+- set_element_adoption()
 - set_guestlogin_settings()
 - set_guestlogin_settings_base()
-- set_ips_settings_base() (supported on controller version 5.9.10 and higher)
+- set_ips_settings_base()
+- set_is_unifi_os()
 - set_locate_ap() (deprecated but still available as alias)
 - set_networksettings_base()
 - set_radius_account_base()
+- set_request_method()
+- set_request_timeout()
+- set_site()
 - set_site_connectivity()
 - set_site_country()
 - set_site_guest_access()
@@ -220,27 +329,30 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - set_wlansettings()
 - set_wlansettings_base()
 - site_leds()
-- site_ledsoff() (deprecated but still available as alias)
-- site_ledson() (deprecated but still available as alias)
 - spectrum_scan()
 - spectrum_scan_state()
 - start_rolling_upgrade()
-- stat_5minutes_aps() (supported on controller version 5.5.X and higher)
+- stat_5minutes_aps()
-- stat_5minutes_gateway() (supported on controller version 5.7.X and higher)
+- stat_5minutes_gateway()
-- stat_5minutes_site() (supported on controller version 5.5.X and higher)
+- stat_5minutes_site()
-- stat_5minutes_user (supported on controller version 5.7.X and higher)
+- stat_5minutes_user()
 - stat_allusers()
 - stat_auths()
 - stat_client()
 - stat_daily_aps()
-- stat_daily_gateway() (supported on controller version 5.7.X and higher)
+- stat_daily_gateway()
 - stat_daily_site()
-- stat_daily_user() (supported on controller version 5.7.X and higher)
+- stat_daily_user()
+- stat_full_status()
 - stat_hourly_aps()
-- stat_hourly_gateway() (supported on controller version 5.7.X and higher)
+- stat_hourly_gateway()
 - stat_hourly_site()
-- stat_hourly_user() (supported on controller version 5.7.X and higher)
+- stat_hourly_user()
-- stat_ips_events() (supported on controller version 5.9.10 and higher)
+- stat_ips_events()
+- stat_monthly_aps()
+- stat_monthly_gateway()
+- stat_monthly_site()
+- stat_monthly_user()
 - stat_payment()
 - stat_sessions()
 - stat_sites()
@@ -249,59 +361,46 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - stat_status()
 - stat_sysinfo()
 - stat_voucher()
-- stat_monthly_aps()
-- stat_monthly_gateway()
-- stat_monthly_site()
-- stat_monthly_user()
 - unauthorize_guest()
 - unblock_sta()
 - unset_locate_ap() (deprecated but still available as alias)
 - upgrade_device()
 - upgrade_device_external()
 
-Other functions, getters/setters:
-
-- get_class_version()
-- get_connection_timeout()
-- get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
-- get_cookies()
-- get_debug()
-- get_is_unifi_os()
-- get_last_error_message()
-- get_last_results_raw()
-- get_request_method()
-- get_site()
-- get_ssl_verify_host()
-- get_ssl_verify_peer()
-- set_connection_timeout()
-- set_cookies()
-- set_debug()
-- set_is_unifi_os()
-- set_request_method()
-- set_site()
-- set_ssl_verify_host()
-- set_ssl_verify_peer()
-
 
 ## Need help or have suggestions?
 
-There is still work to be done to add functionality and further improve the usability of this class, so all suggestions/comments are welcome. Please use the GitHub [issue list](https://github.com/Art-of-WiFi/UniFi-API-client/issues) or the Ubiquiti Community forums (https://community.ubnt.com/t5/UniFi-Wireless/PHP-class-to-access-the-UniFi-controller-API-updates-and/td-p/1512870) to share your suggestions and questions.
+There is still work to be done to add functionality and further improve the usability of
+this class, so all suggestions/comments are welcome. Please use the GitHub
+[Issues section](https://github.com/Art-of-WiFi/UniFi-API-client/issues) or the Ubiquiti
+Community forums (https://community.ubnt.com/t5/UniFi-Wireless/PHP-class-to-access-the-UniFi-controller-API-updates-and/td-p/1512870)
+to share your suggestions and questions.
+
+
+#### IMPORTANT NOTE:
+When encountering issues with the UniFi API using other libraries, cURL or Postman, please do **not** open an Issue. Such issues will be closed immediately.
+Please use the [Discussions](https://github.com/Art-of-WiFi/UniFi-API-client/discussions) section instead.
+
 
 ## Contribute
 
-If you would like to contribute code (improvements), please open an issue and include your code there or else create a pull request.
+If you would like to contribute code (improvements), please open an issue and include
+your code there or else create a pull request.
+
 
 ## Credits
 
 This class is based on the initial work by the following developers:
 
-- domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
+- domwo: https://community.ui.com/questions/little-php-class-for-unifi-api/933d3fb3-b401-4499-993a-f9af079a4a3a
 - fbagnol: https://github.com/fbagnol/class.unifi.php
 
 and the API as published by Ubiquiti:
 
-- https://dl.ui.com/unifi/6.0.41/unifi_sh_api
+- https://dl.ui.com/unifi/8.0.26/unifi_sh_api
+
 
 ## Important Disclaimer
 
-Many of the functions in this API client class are not officially supported by UBNT and as such, may not be supported in future versions of the UniFi Controller API.
+Many of the functions in this API client class are not officially supported by Ubiquiti
+and as such, may not be supported in future versions of the UniFi Controller API.

composer.json

@@ -1,6 +1,6 @@
 {
-    "name":        "art-of-wifi/unifi-api-client",
+    "name": "art-of-wifi/unifi-api-client",
-    "type":        "library",
+    "type": "library",
     "description": "API client class for use with Ubiquiti's UniFi controller",
     "keywords": [
         "ubnt",
@@ -10,17 +10,17 @@
         "api",
         "client"
     ],
-    "homepage":    "https://github.com/Art-of-WiFi/UniFi-API-client",
+    "homepage": "https://github.com/Art-of-WiFi/UniFi-API-client",
-    "license":     "MIT",
+    "license": "MIT",
     "authors": [
         {
-            "name":     "Art of WiFi",
+            "name": "Art of WiFi",
-            "email":    "info@artofowifi.net",
+            "email": "info@artofowifi.net",
-            "homepage": "http://artofwifi.net"
+            "homepage": "https://artofwifi.net"
         }
     ],
     "require": {
-        "php": ">=5.5.0",
+        "php": ">=7.4.0",
         "ext-curl": "*",
         "ext-json": "*"
     },
@@ -29,4 +29,4 @@
             "UniFi_API\\": "src/"
         }
     }
-}
+}

examples/README.md

@@ -1,18 +1,21 @@
 ## API client class usage examples
 
-This directory contains some PHP code examples which demonstrate usage of the PHP API client class and can be used as a good starting point for your own custom code.
+This directory contains some PHP code examples which demonstrate usage of the PHP API client class and can be used as a
+good starting point for your own custom code.
 
 ### Usage
 
-Copy the appropriate example file to your working directory together with a copy of the config.template.php file which should be renamed to config.php.
+Copy the appropriate example file to your working directory together with a copy of the config.template.php file which
-Then update the contents of your new config.php with your controller details and credentials and modify the example file as required to fit your needs.
+should be renamed to config.php. Then update the contents of your new config.php with your controller details and
+credentials and modify the example file as required to fit your needs.
 
-Also make sure to update the path for the composer autoloader file (`vendor/autoload.php`) or the file containing the Class itself (`src/Client.php`) in your `require_once()` statement as required.
+Also make sure to update the path for the composer autoloader file (`vendor/autoload.php`) or the file containing the
+Class itself (`src/Client.php`) in your `require_once()` statement as required.
 
 #### Executing scripts from the CLI
 
-Most of the included example scripts can be run from the CLI or shell as follows after the necessary credentials and parameters have been added or updated:
+Most of the included example scripts can be run from the CLI or shell as follows after the necessary credentials and
-
+parameters have been added or updated:
 
 ```sh
 $ php list_site_health.php
@@ -22,7 +25,8 @@ NOTE: this does require the `php-cli` module to be installed
 
 ### Contribute
 
-If you would like to share your own example file(s), please open an issue and include your code there or else create a pull request.
+If you would like to share your own example file(s), please open an issue and include your code there or else create a
+pull request.
 
 ## Important Disclaimer
 

examples/ap_scanning_state.php

@@ -28,7 +28,14 @@ $ap_mac  = '<enter MAC address of Access Point to check>';
  * initialize the UniFi API connection class and log in to the controller and do our thing
  * spectrum_scan_state()
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode   = $unifi_connection->set_debug($debug);
 $loginresults     = $unifi_connection->login();
 $data             = $unifi_connection->spectrum_scan_state($ap_mac);

examples/ap_upgrade_firmware.php

@@ -24,8 +24,15 @@ $device_mac = '<enter MAC address of device to update>';
  * initialize the UniFi API connection class, log in to the controller
  * (this example assumes you have already assigned the correct values in config.php to the variables used)
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, false);
+$unifi_connection = new UniFi_API\Client(
-$login            = $unifi_connection->login();
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$login = $unifi_connection->login();
 
 /**
  * Run the actual upgrade

examples/auth_guest_basic.php

@@ -45,9 +45,16 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 /**
  * then we authorize the device for the requested duration

examples/auth_guest_with_note.php

@@ -42,9 +42,16 @@ $note = 'Note to attach to newly authorized device';
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 /**
  * we authorize the device for the requested duration and attach the note to it's object

examples/block_list.php

@@ -42,9 +42,16 @@ if ($site_id == "MUST_DEFINE_THIS") {
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login(); // always true regardless of site id
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login(); // always true regardless of site id
 
 foreach ($macs_to_block as $mac) {
     // block_result is always true even if mac address does not exist :(

examples/change_super_mgmt.php

@@ -25,19 +25,26 @@ $debug   = false;
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, true);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$site_settings    = $unifi_connection->list_settings();
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
 
-$super_mgmt_settings = [];
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$site_settings  = $unifi_connection->list_settings();
+
+$super_mgmt_settings    = [];
 $super_mgmt_settings_id = '';
 
 if (!empty($site_settings)) {
-    foreach($site_settings as $section) {
+    foreach ($site_settings as $section) {
         echo 'section key: ' . $section->key . PHP_EOL;
         if ($section->key === 'super_mgmt') {
-            $super_mgmt_settings = $section;
+            $super_mgmt_settings    = $section;
             $super_mgmt_settings_id = $section->_id;
         }
     }

examples/change_wlan_password.php

@@ -35,10 +35,17 @@ $new_password = '<new password goes here>';
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$results          = $unifi_connection->set_wlansettings($wlan_id, $new_password);
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$results        = $unifi_connection->set_wlansettings($wlan_id, $new_password);
 
 /**
  * provide feedback in json format

examples/create_site.php

@@ -30,9 +30,16 @@ $description = 'new site';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$loginresults     = $unifi_connection->login();
+    $controlleruser,
-$results          = $unifi_connection->create_site($description);
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$loginresults = $unifi_connection->login();
+$results      = $unifi_connection->create_site($description);
 
 /**
  * provide feedback in json format

examples/create_voucher.php

@@ -35,9 +35,16 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 /**
  * then we create the required number of vouchers with the requested expiration value

examples/delete_site.php

@@ -31,9 +31,16 @@ $site_to_delete = '<_id value of the site>';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$loginresults     = $unifi_connection->login();
+    $controlleruser,
-$results          = $unifi_connection->delete_site($site_to_delete);
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$loginresults = $unifi_connection->login();
+$results      = $unifi_connection->delete_site($site_to_delete);
 
 /**
  * provide feedback in json format

examples/disable_device.php

@@ -30,9 +30,16 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 /**
  * then we disable the device

examples/disable_switch_port.php

@@ -46,7 +46,14 @@ $port_conf_id = '<enter _id value of desired port configuration>';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection   = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, false);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode     = $unifi_connection->set_debug($debug);
 $loginresults       = $unifi_connection->login();
 $data               = $unifi_connection->list_devices($device_mac);

examples/execute_custom_api_request.php

@@ -35,10 +35,17 @@ $return         = 'array';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$results          = $unifi_connection->custom_api_request($url, $request_method, $payload, $return);
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$results        = $unifi_connection->custom_api_request($url, $request_method, $payload, $return);
 
 /**
  * provide feedback in JSON format or as PHP Object

examples/extend_guest_auth.php

@@ -23,9 +23,16 @@ require_once 'config.php';
 $site_id   = "default";
 $site_name = "*enter your site name*";
 
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 if ($loginresults === 400) {
     print "UniFi controller login failure, please check your credentials in config.php.\n";
@@ -36,7 +43,8 @@ if ($loginresults === 400) {
      * loop thru all known guests
      */
     foreach ($guestlist as $guest) {
-        print "<pre>" . $guest->_id . " (" . $guest->mac . "), valid until " . date(DATE_ATOM, $guest->end) . " (" . $guest->end . ")</pre>";
+        print "<pre>" . $guest->_id . " (" . $guest->mac . "), valid until " .
+              date(DATE_ATOM, $guest->end) . " (" . $guest->end . ")</pre>";
 
         /**
          * just a sample: only extend validity of guests which have end date after 2017-04-02

examples/list_alarms.php

@@ -25,7 +25,14 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode   = $unifi_connection->set_debug($debug);
 $loginresults     = $unifi_connection->login();
 $data             = $unifi_connection->list_alarms();

examples/list_ap_connected_users.php

@@ -26,10 +26,17 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller and pull the requested data
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$aps_array        = $unifi_connection->list_aps();
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$aps_array      = $unifi_connection->list_aps();
 
 /**
  * output the results in HTML format

examples/list_connected_users.php

@@ -25,10 +25,17 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller and pull the requested data
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$clients_array    = $unifi_connection->list_clients();
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$clients_array  = $unifi_connection->list_clients();
 
 /**
  * output the results in JSON format

examples/list_site_health.php

@@ -26,14 +26,20 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller and pull the requested data
  */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
 
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$set_debug_mode = $unifi_connection->set_debug($debug);
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
-$loginresults     = $unifi_connection->login();
+$result         = $unifi_connection->list_health();
-$result           = $unifi_connection->list_health();
 
 /**
  * output the results in correct json formatting
  */
 header('Content-Type: application/json');
-echo (json_encode($result, JSON_PRETTY_PRINT));
+echo(json_encode($result, JSON_PRETTY_PRINT));

examples/list_sites.php

@@ -26,10 +26,17 @@ $site_id = 'default';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$data             = $unifi_connection->list_sites();
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_sites();
 
 /**
  * we can render the full results in json format

examples/list_social_auth_details.php

@@ -26,10 +26,17 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$data             = $unifi_connection->stat_payment();
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->stat_payment();
 
 /**
  * cycle through the results and print social auth details if set,

examples/list_user_stats.php

@@ -38,12 +38,19 @@ $attribs = ['rx_bytes', 'tx_bytes'];
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, true);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug(false);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
 //$data             = $unifi_connection->stat_5minutes_user($mac, null, null, $attribs);
 //$data             = $unifi_connection->stat_hourly_user($mac, null, null, $attribs);
-$data             = $unifi_connection->stat_daily_user($mac, null, null, $attribs);
+$data = $unifi_connection->stat_daily_user($mac, null, null, $attribs);
 
 /**
  * provide feedback in json format

examples/modify_smartpower_pdu_outlet.php

@@ -49,39 +49,52 @@ $new_cycle_enabled = false;
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-if ($loginresults) {
+    $controllerurl,
-    $pdu_details = $unifi_connection->list_devices($pdu_mac);
+    $site_id,
+    $controllerversion
+);
 
-    /**
+$set_debug_mode = $unifi_connection->set_debug($debug);
-     * change the model below from USPPDUP to UP1 when using a USP-Plug (thanks to @thesohoguy for contributing this)
+$loginresults   = $unifi_connection->login();
-     */
+if (!$loginresults) {
-    if (!empty($pdu_details) && property_exists($pdu_details[0], 'model') && $pdu_details[0]->model === 'USPPDUP' && property_exists($pdu_details[0], 'outlet_overrides')) {
-        $device_id        = $pdu_details[0]->_id;
-        $outlet_overrides = $pdu_details[0]->outlet_overrides;
-
-        foreach ($outlet_overrides as $key => $value) {
-            if ($value->index === $outlet_idx) {
-                $outlet_overrides[$key]->relay_state   = $new_relay_state;
-                $outlet_overrides[$key]->cycle_enabled = $new_cycle_enabled;
-            }
-        }
-
-        $pdu_update = $unifi_connection->set_device_settings_base($device_id, ['outlet_overrides' => $outlet_overrides]);
-
-        /**
-         * provide feedback in json format
-         */
-        echo 'results:' . PHP_EOL . PHP_EOL;
-        echo json_encode($pdu_update, JSON_PRETTY_PRINT);
-        echo PHP_EOL;
-    } else {
-        echo 'not a PDU device?';
-        echo PHP_EOL;
-    }
-} else {
     echo 'we encountered a login error!';
     echo PHP_EOL;
-}
+    exit();
+}
+
+$pdu_details = $unifi_connection->list_devices($pdu_mac);
+
+/**
+ * change the model below from USPPDUP to UP1 when using a USP-Plug (thanks to @thesohoguy for contributing this)
+ */
+if (
+    !empty($pdu_details) &&
+    property_exists($pdu_details[0], 'model') &&
+    $pdu_details[0]->model === 'USPPDUP' &&
+    property_exists($pdu_details[0], 'outlet_overrides')
+) {
+    $device_id        = $pdu_details[0]->_id;
+    $outlet_overrides = $pdu_details[0]->outlet_overrides;
+
+    foreach ($outlet_overrides as $key => $value) {
+        if ($value->index === $outlet_idx) {
+            $outlet_overrides[$key]->relay_state   = $new_relay_state;
+            $outlet_overrides[$key]->cycle_enabled = $new_cycle_enabled;
+        }
+    }
+
+    $pdu_update = $unifi_connection->set_device_settings_base($device_id,
+        ['outlet_overrides' => $outlet_overrides]);
+
+    /**
+     * provide feedback in json format
+     */
+    echo 'results:' . PHP_EOL . PHP_EOL;
+    echo json_encode($pdu_update, JSON_PRETTY_PRINT);
+} else {
+    echo 'not a PDU device?';
+}
+echo PHP_EOL;

examples/reconnect_client.php

@@ -30,9 +30,16 @@ $site_id = '<enter your site id here>';
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 /**
  * then we force the device to reconnect

examples/set_vlan_to_port.php

@@ -0,0 +1,153 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Samuel Schnelly
+ * description:    example basic PHP script to change VLAN on port
+ */
+
+/**
+ * using the composer autoloader
+ */
+require_once 'vendor/autoload.php';
+
+/**
+ * include the config file (place your credentials etc. there if not already present)
+ * see the config.template.php file for an example
+ */
+require_once 'config.php';
+
+/**
+ * the site to use
+ */
+$site_id = '<enter your site id here>';
+
+/**
+ * initialize the UniFi API connection class and log in to the controller and do our thing
+ */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
+
+/**
+ * change VLAN on port
+ */
+$port = 1;
+$vlan = 200;
+
+/**
+ * MAC Address of the UniFi device
+ */
+$mac = '<enter your device mac address here>';
+
+set_port_vlan($mac, $port, $vlan, $unifi_connection);
+
+/**
+ * Set specific VLAN on device port
+ *
+ * @param string $device_mac MAC Address of UNIFI device
+ * @param int $port_idx Port number of UNIFI device, note: started by 1
+ * @param int $vlan_id VLAN ID to set
+ * @param UniFi_API\Client $unifi_connection
+ *
+ * @return bool true if result is success, false upon failure
+ */
+function set_port_vlan($device_mac, $port_idx, $vlan_id, $unifi_connection)
+{
+    $device = $unifi_connection->list_devices($device_mac);
+
+    // if no device found
+    if (count($device) == 0) {
+        trigger_error('set_port_vlan() device not found');
+        return false;
+    }
+
+    $port_table = $device[0]->port_table;
+    $def_port   = null;
+
+    // check if port exists
+    $exist = false;
+    foreach ($port_table as $key => $port) {
+        if ($port->port_idx == $port_idx) {
+            $exist    = true;
+            $def_port = $port;
+            break;
+        }
+    }
+
+    if (!$exist) {
+        trigger_error('set_port_vlan() port_idx not found on device');
+        return false;
+    }
+
+    // check if vlan exists
+    $native_networkconf_id = null;
+
+    foreach ($unifi_connection->list_networkconf() as $key => $network) {
+        if ($network->purpose == 'vlan-only' && $network->vlan == $vlan_id) {
+            $native_networkconf_id = $network->_id;
+        }
+    }
+
+    if ($native_networkconf_id === null) {
+        trigger_error('set_port_vlan() vlan not exist');
+        return false;
+    }
+
+    $exist = false;
+    foreach ($device[0]->port_overrides as $key => $port) {
+        if ($port->port_idx == $port_idx) {
+            $exist                                                  = true;
+            $device[0]->port_overrides[$key]->native_networkconf_id = $native_networkconf_id;
+            break;
+        }
+    }
+
+    if (!$exist) {
+        $device[0]->port_overrides[] = [
+            'port_idx'                              => isset($port_idx) ? $port_idx : 1,
+            'setting_preference'                    => isset($setting_preference) ? $setting_preference : 'auto',
+            'name'                                  => isset($def_port->name) ? $def_port->name : 'Port 1',
+            'op_mode'                               => isset($def_port->op_mode) ? $def_port->op_mode : 'switch',
+            'port_security_enabled'                 => isset($def_port->port_security_enabled) ? $def_port->port_security_enabled : false,
+            'port_security_mac_address'             => isset($def_port->port_security_mac_address) ? $def_port->port_security_mac_address : [],
+            'native_networkconf_id'                 => isset($native_networkconf_id) ? $native_networkconf_id : '',
+            'excluded_networkconf_ids'              => isset($def_port->excluded_networkconf_ids) ? $def_port->excluded_networkconf_ids : [],
+            'show_traffic_restriction_as_allowlist' => isset($def_port->show_traffic_restriction_as_allowlist) ? $def_port->show_traffic_restriction_as_allowlist : false,
+            'forward'                               => isset($def_port->forward) ? $def_port->forward : 'customize',
+            'lldpmed_enabled'                       => isset($def_port->lldpmed_enabled) ? $def_port->lldpmed_enabled : true,
+            'voice_networkconf_id'                  => isset($def_port->voice_networkconf_id) ? $def_port->voice_networkconf_id : '',
+            'stormctrl_bcast_enabled'               => isset($def_port->stormctrl_bcast_enabled) ? $def_port->stormctrl_bcast_enabled : false,
+            'stormctrl_bcast_rate'                  => isset($def_port->stormctrl_bcast_rate) ? $def_port->stormctrl_bcast_rate : 100,
+            'stormctrl_mcast_enabled'               => isset($def_port->stormctrl_mcast_enabled) ? $def_port->stormctrl_mcast_enabled : false,
+            'stormctrl_mcast_rate'                  => isset($def_port->stormctrl_mcast_rate) ? $def_port->stormctrl_mcast_rate : 100,
+            'stormctrl_ucast_enabled'               => isset($def_port->stormctrl_ucast_enabled) ? $def_port->stormctrl_ucast_enabled : false,
+            'stormctrl_ucast_rate'                  => isset($def_port->stormctrl_ucast_rate) ? $def_port->stormctrl_ucast_rate : 100,
+            'egress_rate_limit_kbps_enabled'        => isset($def_port->egress_rate_limit_kbps_enabled) ? $def_port->egress_rate_limit_kbps_enabled : false,
+            'autoneg'                               => isset($def_port->autoneg) ? $def_port->autoneg : true,
+            'isolation'                             => isset($def_port->isolation) ? $def_port->isolation : false,
+            'stp_port_mode'                         => isset($def_port->stp_port_mode) ? $def_port->stp_port_mode : true,
+            'port_keepalive_enabled'                => isset($def_port->port_keepalive_enabled) ? $def_port->port_keepalive_enabled : false
+        ];
+
+    }
+
+    $payload = [
+        'port_overrides' => $device[0]->port_overrides
+    ];
+
+    $result = $unifi_connection->set_device_settings_base($device[0]->device_id, $payload);
+
+    if ($result) {
+        return true;
+    }
+
+    return false;
+}

examples/test_connection.php

@@ -15,8 +15,9 @@ require_once 'config.php';
 
 /**
  * Check whether the cURL module supports SSL
+ * http://www.php.net/manual/en/function.curl-version.php
  */
-if (!curl_version()['features'] & CURL_VERSION_SSL) {
+if (!(curl_version()['features'] & CURL_VERSION_SSL)) {
     print PHP_EOL . 'SSL is not supported with this cURL installation!' . PHP_EOL;
 }
 
@@ -25,27 +26,28 @@ if (!curl_version()['features'] & CURL_VERSION_SSL) {
  */
 $ch = curl_init();
 
-if (is_resource($ch)) {
+if (is_resource($ch) || is_object($ch)) {
     /**
-     * If we have a resource, we proceed and set the required cURL options
+     * If we have a resource or object (for PHP > 8.0), we proceed and set the required cURL options
-     */
+     *
-    curl_setopt($ch, CURLOPT_URL, $controllerurl);
+     * NOTES:
-    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
+     * The cURL option CURLOPT_SSLVERSION can have a value of 0-6
-    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
-    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
-
-    /**
-     * This cURL option can have a value of 0-6
      * see this URL for more details:
      * http://php.net/manual/en/function.curl-setopt.php
      * 0 is the default value and is used by the PHP API client class
      */
-    curl_setopt($ch, CURLOPT_SSLVERSION, 0);
+    $curl_options = [
+        CURLOPT_PROTOCOLS      => CURLPROTO_HTTPS,
+        CURLOPT_URL            => $controllerurl,
+        CURLOPT_CUSTOMREQUEST  => 'GET',
+        CURLOPT_SSL_VERIFYPEER => false,
+        CURLOPT_SSL_VERIFYHOST => false,
+        CURLOPT_VERBOSE        => true,
+        CURLOPT_SSLVERSION     => 0,
+        CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
+    ];
 
-    /**
+    curl_setopt_array($ch, $curl_options);
-     * Be more verbose
-     */
-    curl_setopt($ch, CURLOPT_VERBOSE, true);
 
     /**
      * $results contains the output as returned by the cURL request,
@@ -64,9 +66,13 @@ if (is_resource($ch)) {
         print PHP_EOL . 'cURL error: ' . curl_error($ch) . PHP_EOL;
     }
 
-    print PHP_EOL . '$results:' . PHP_EOL;
+    print PHP_EOL . 'test result:' . PHP_EOL;
-    print_r($results);
+    if ($results) {
-    print PHP_EOL;
+        print 'Controller connection success' . PHP_EOL;
+        die;
+    }
+
+    print 'Controller connection failed' . PHP_EOL;
 } else {
     print PHP_EOL . 'ERROR: cURL could not be initialized!' . PHP_EOL;
 }

examples/toggle_auto_update_settings.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description: example to toggle the site-wide auto upgrade setting on a UniFi controller
+ */
+
+/**
+ * using the composer autoloader
+ */
+require_once('vendor/autoload.php');
+
+/**
+ * include the config file (place your credentials etc. there if not already present)
+ * see the config.template.php file for an example
+ *
+ * @var string $controlleruser the user name for access to the UniFi Controller
+ * @var string $controllerpassword the password for access to the UniFi Controller
+ * @var string $controllerurl full url to the UniFi Controller, eg. 'https://
+ * @var string $controllerversion the version of the Controller software, eg. '4.6.6' (must be at least 4.0.0)
+ * @var bool $debug set to true (without quotes) to enable debug output to the browser and the PHP error log
+ */
+require_once('config.php');
+
+/**
+ * site id for the site where settings are to be updated
+ */
+$site_id = 'zzzzz';
+
+/**
+ * initialize the UniFi API connection class and log in to the controller to do our thing
+ */
+$unifi_connection = new UniFi_API\Client(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$login_results = $unifi_connection->login();
+
+if ($login_results) {
+    /**
+     * we get the current site mgmt settings
+     */
+    $current_site_settings = $unifi_connection->list_settings();
+
+    $mgmt_settings = [];
+    foreach ($current_site_settings as $section) {
+        if ($section->key == 'mgmt') {
+            $mgmt_settings = $section;
+        }
+    }
+
+    /**
+     * toggle the auto upgrade setting and set the auto upgrade hour to 3
+     */
+    $mgmt_settings->auto_upgrade      = !$mgmt_settings->auto_upgrade;
+    $mgmt_settings->auto_upgrade_hour = 3;
+    $mgmt_id                          = $mgmt_settings->_id;
+    $set_result                       = $unifi_connection->set_site_mgmt($mgmt_id, $mgmt_settings);
+
+    echo 'done' . PHP_EOL;
+    exit();
+}
+
+echo 'login failed' . PHP_EOL;

examples/toggle_led.php

@@ -31,9 +31,16 @@ $mac = '<enter MAC address of your AP here>';
 /**
  * initialize the UniFi API connection class and log in to the controller to do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion); // initialize the class instance
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login();
 
 /**
  * using the new method/function

examples/unblock_list.php

@@ -43,9 +43,16 @@ if ($site_id == "MUST_DEFINE_THIS") {
 /**
  * initialize the UniFi API connection class and log in to the controller
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug($debug);
+    $controlleruser,
-$loginresults     = $unifi_connection->login(); // always true regardless of site id
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug($debug);
+$loginresults   = $unifi_connection->login(); // always true regardless of site id
 
 foreach ($macs_to_unblock as &$mac) {
     // block_result is always true even if mac address does not exist :(

examples/update_ac-iw_ports.php

@@ -47,11 +47,11 @@ $port_conf_id_port_2 = '<_id of port configuration to apply to port #2>';
 $new_ports_config = [
     'port_overrides' => [
         [
-            'port_idx' => 1,
+            'port_idx'    => 1,
             'portconf_id' => $port_conf_id_port_1
         ],
         [
-            'port_idx' => 2,
+            'port_idx'    => 2,
             'portconf_id' => $port_conf_id_port_2
         ]
     ]
@@ -60,12 +60,19 @@ $new_ports_config = [
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, false);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug(false);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$data             = $unifi_connection->list_devices($device_mac);
+    $controllerurl,
-$device_id        = $data[0]->device_id;
+    $site_id,
-$update_device    = $unifi_connection->set_device_settings_base($device_id, $new_ports_config);
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_devices($device_mac);
+$device_id      = $data[0]->device_id;
+$update_device  = $unifi_connection->set_device_settings_base($device_id, $new_ports_config);
 
 if (!$update_device) {
     $error = $unifi_connection->get_last_results_raw();

examples/update_device_wlan_settings_5.5.X.php

@@ -51,22 +51,29 @@ $na_channel = 44;
 /**
  * initialize the UniFi API connection class and log in to the controller and do our thing
  */
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, false);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug(false);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$data             = $unifi_connection->list_devices($ap_mac);
+    $controllerurl,
-$radio_table      = $data[0]->radio_table;
+    $site_id,
-$device_id        = $data[0]->device_id;
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_devices($ap_mac);
+$radio_table    = $data[0]->radio_table;
+$device_id      = $data[0]->device_id;
 
 foreach ($radio_table as $radio) {
     if ($radio->radio === 'ng') {
         $radio->tx_power_mode = $ng_tx_power_mode;
-        $radio->channel = $ng_channel;
+        $radio->channel       = $ng_channel;
     }
 
     if ($radio->radio === 'na') {
         $radio->tx_power_mode = $na_tx_power_mode;
-        $radio->channel = $na_channel;
+        $radio->channel       = $na_channel;
     }
 }
 

examples/update_switch_poe-mode.php

@@ -8,6 +8,9 @@
  * usage:          If the file is called via a web URL, it should be called like: update_switch_poe-mode.php?poe_mode=off
  *                 If the file is called via the command line, it should be called like: php update_switch_poe-mode.php off
  *                 The values can be "off" or "auto"
+ *
+ * IMPORTANT INFORMATION:
+ * This example no longer works with controller versions 7.1.X and higher. You now need to work with port profiles to enable POE on a switch port.
  */
 
 /**
@@ -39,20 +42,21 @@ $lanports = [6];
 /**
  * This is the function that reads out the current port configuration and changes the value for the poe_mode for the ports defined in $lanports
  */
-function update_ports($running_config, $ports, $poe_mode){
+function update_ports($running_config, $ports, $poe_mode)
+{
     /**
      * Update already non-default ports
      */
     $running_config_count = count($running_config);
-    for($i = 0; $i < $running_config_count; $i++){
+    for ($i = 0; $i < $running_config_count; $i++) {
-        if(in_array($running_config[$i]->port_idx, $ports)){
+        if (in_array($running_config[$i]->port_idx, $ports)) {
             $running_config[$i]->poe_mode = $poe_mode;
             unset($ports[array_search($running_config[$i]->port_idx, $ports)]);
         }
     }
 
     $add_conf = [];
-    foreach($ports as $port){
+    foreach ($ports as $port) {
         $add_conf[] = [
             'port_idx' => $port,
             'poe_mode' => $poe_mode
@@ -62,12 +66,19 @@ function update_ports($running_config, $ports, $poe_mode){
     return array_merge($running_config, $add_conf);
 }
 
-$unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion, false);
+$unifi_connection = new UniFi_API\Client(
-$set_debug_mode   = $unifi_connection->set_debug(false);
+    $controlleruser,
-$loginresults     = $unifi_connection->login();
+    $controllerpassword,
-$data             = $unifi_connection->list_devices($device_mac);
+    $controllerurl,
-$device_id        = $data[0]->device_id;
+    $site_id,
-$current_conf     = $data[0]->port_overrides;
+    $controllerversion
+);
+
+$set_debug_mode = $unifi_connection->set_debug(false);
+$loginresults   = $unifi_connection->login();
+$data           = $unifi_connection->list_devices($device_mac);
+$device_id      = $data[0]->device_id;
+$current_conf   = $data[0]->port_overrides;
 
 /**
  * This reads in the values provided via URL or in the command line, if nothing is set than it will poe_mode will be set to "auto"
@@ -91,4 +102,4 @@ if (!$update_device) {
     echo json_encode($error, JSON_PRETTY_PRINT);
 }
 
-echo json_encode($update_device, JSON_PRETTY_PRINT);
+echo json_encode($update_device, JSON_PRETTY_PRINT);