API client class v1.1.67

- fixed a bug where the request headers for subsequent function calls within the same Client instance would not always be cleared

.gitignore

@@ -5,5 +5,9 @@
 /vendor/
 /composer.lock
 
+# ignore phpdoc files
+/build
+.phpdoc-md
+
 # ignore XML files
 *.xml

README.md

@@ -1,27 +1,32 @@
 ## UniFi Controller API client class
 
-A PHP class that provides access to Ubiquiti's [**UniFi SDN Controller**](https://unifi-sdn.ui.com/) API, versions 4.X.X and 5.X.X of the UniFi SDN Controller software are supported (version 5.12.35 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 in 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 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).
+
+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 using composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for easy inclusion in your projects.
 
 ## Requirements
 
-- a web server with PHP and cURL modules 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)
-- network connectivity between this web server and the server and port (normally TCP port 8443) where the UniFi Controller is running
+- 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)
+- direct network connectivity between this server and the host and port (normally TCP port 8443) where the UniFi Controller is running
+- you must use **local accounts**, not UniFi Cloud accounts, to access the UniFi Controller API through this class
+
 
 ## UniFi OS Support
 
-Support for UniFi OS-based controllers (UniFi Dream Machine Pro) 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 (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.
 
 Please test all methods you plan on using thoroughly before using the API Client with UniFi OS devices in a production environment.
 
+
 ## Installation
 
-You can 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 method is via [composer](https://getcomposer.org). Follow the [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 do not already have composer installed.
 
 Once composer is installed, simply execute this command from the shell in your project directory:
 
@@ -29,7 +34,7 @@ Once composer is installed, simply execute this command from the shell in your p
 composer require art-of-wifi/unifi-api-client
 ```
 
- Or you can manually add the package to your composer.json file:
+ Or manually add the package to your composer.json file:
 
 ```javascript
 {
@@ -42,9 +47,10 @@ composer require art-of-wifi/unifi-api-client
 Finally, be sure to include the autoloader in your code:
 
 ```php
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 ```
 
+
 ### Git
 
 Execute the following `git` command from the shell in your project directory:
@@ -56,17 +62,19 @@ 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
-require_once('path/to/src/Client.php');
+require_once 'path/to/src/Client.php';
 ```
 
+
 ### Download the Release
 
-If you prefer not to use composer or git, you can 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), uncompress the zip file, then include the file containing the class in your code like so:
 
 ```php
-require_once('path/to/src/Client.php');
+require_once 'path/to/src/Client.php';
 ```
 
+
 ## Example usage
 
 A basic example how to use the class:
@@ -75,7 +83,7 @@ A basic example how to use the class:
 /**
  * load the class using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * initialize the Unifi API connection class, log in to the controller and request the alarms collection
@@ -86,39 +94,49 @@ $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 you can use 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 SDN 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 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.
+
 
 ## 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 source code for more details on the functions/methods and their respective parameters.
+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.
 
 - login()
 - logout()
 - 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)
+- create_dynamicdns()
 - create_firewallgroup()
 - create_hotspotop()
 - create_network()
 - create_radius_account()
 - create_site()
-- create_usergroup()
 - create_user()
+- create_usergroup()
 - create_voucher()
 - create_wlan()
 - custom_api_request()
+- delete_apgroup() (supported with controller versions 6.0.X and higher)
 - delete_device()
 - delete_firewallgroup()
 - delete_network()
@@ -127,18 +145,18 @@ 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)
 - edit_client_fixedip()
 - edit_firewallgroup()
 - edit_usergroup()
 - extend_guest_validity()
 - forget_sta() (supported on controller version 5.9.X and higher)
 - invite_admin()
-- assign_existing_admin()
-- revoke_admin()
 - led_override()
 - list_admins()
-- list_all_admins()
 - list_alarms()
+- list_all_admins()
+- list_apgroups() (supported with controller versions 6.0.X and higher)
 - list_aps() (deprecated but still available as alias)
 - list_backups()
 - list_clients()
@@ -146,11 +164,13 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - list_current_channels()
 - list_dashboard()
 - list_devices()
+- list_device_name_mappings()
 - list_dpi_stats()
 - list_dynamicdns()
 - list_events()
 - list_extension()
 - list_firewallgroups()
+- list_firmware()
 - list_guests()
 - list_health()
 - list_hotspotop()
@@ -162,6 +182,7 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - list_radius_accounts() (supported on controller version 5.5.19 and higher)
 - list_radius_profiles()
 - list_rogueaps()
+- list_routing()
 - list_self()
 - list_settings()
 - list_sites()
@@ -173,14 +194,17 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - locate_ap()
 - move_device()
 - power_cycle_switch_port()
+- reboot_cloudkey()
 - reconnect_sta()
 - rename_ap()
 - restart_ap() (deprecated but still available as alias)
 - restart_device()
-- reboot_cloudkey()
+- revoke_admin()
 - revoke_voucher()
 - set_ap_radiosettings()
 - set_device_settings_base()
+- set_dynamicdns()
+- set_element_adoption() (supported on controller version 5.13.X and higher)
 - set_guestlogin_settings()
 - set_guestlogin_settings_base()
 - set_ips_settings_base() (supported on controller version 5.9.10 and higher)
@@ -195,11 +219,11 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - set_site_name()
 - set_site_ntp()
 - set_site_snmp()
-- set_super_mgmt_settings_base()
-- set_super_smtp_settings_base()
-- set_super_identity_settings_base()
 - set_sta_name()
 - set_sta_note()
+- set_super_identity_settings_base()
+- set_super_mgmt_settings_base()
+- set_super_smtp_settings_base()
 - set_usergroup()
 - set_wlan_mac_filter()
 - set_wlansettings()
@@ -209,57 +233,76 @@ The class currently supports the following functions/methods to GET/POST/PUT/DEL
 - 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_gateway() (supported on controller version 5.7.X and higher)
+- stat_5minutes_site() (supported on controller version 5.5.X and higher)
+- stat_5minutes_user (supported on controller version 5.7.X and higher)
 - stat_allusers()
 - stat_auths()
 - stat_client()
-- stat_5minutes_aps() (supported on controller version 5.5.X and higher)
-- stat_hourly_aps()
 - stat_daily_aps()
-- stat_5minutes_gateway() (supported on controller version 5.7.X and higher)
-- stat_hourly_gateway() (supported on controller version 5.7.X and higher)
 - stat_daily_gateway() (supported on controller version 5.7.X and higher)
-- stat_5minutes_site() (supported on controller version 5.5.X and higher)
-- stat_hourly_site()
 - stat_daily_site()
-- stat_5minutes_user (supported on controller version 5.7.X and higher)
-- stat_hourly_user() (supported on controller version 5.7.X and higher)
 - stat_daily_user() (supported on controller version 5.7.X and higher)
+- stat_hourly_aps()
+- stat_hourly_gateway() (supported on controller version 5.7.X and higher)
+- stat_hourly_site()
+- stat_hourly_user() (supported on controller version 5.7.X and higher)
+- stat_ips_events() (supported on controller version 5.9.10 and higher)
 - stat_payment()
 - stat_sessions()
 - stat_sites()
 - stat_speedtest_results()
-- stat_ips_events() (supported on controller version 5.9.10 and higher)
 - stat_sta_sessions_latest()
 - stat_status()
+- stat_full_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()
-- start_rolling_upgrade()
-- cancel_rolling_upgrade()
-- cmd_stat()
 
-Internal functions, getters/setters:
+Other functions, getters/setters:
 
-- set_debug()
+- get_class_version()
+- get_connection_timeout()
+- get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
+- get_cookies()
 - get_debug()
-- set_site()
-- get_site()
-- get_cookie() (renamed from getcookie())
-- get_last_results_raw()
+- 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.
 
+
 ## Contribute
 
 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:
@@ -269,7 +312,8 @@ This class is based on the initial work by the following developers:
 
 and the API as published by Ubiquiti:
 
-- https://dl.ui.com/unifi/5.12.35/unifi_sh_api
+- https://dl.ui.com/unifi/6.0.41/unifi_sh_api
+
 
 ## Important Disclaimer
 

composer.json

@@ -20,8 +20,9 @@
         }
     ],
     "require": {
-        "php": ">=5.4.0",
-		"ext-curl": "*"
+        "php": ">=5.5.0",
+        "ext-curl": "*",
+        "ext-json": "*"
     },
     "autoload": {
         "psr-4": {

examples/ap_scanning_state.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * site id and MAC address of AP to query

examples/ap_upgrade_firmware.php

@@ -6,8 +6,8 @@
  * description:    example script to upgrade device firmware (can be scheduled with systemd/cron)
  *                 to the most current version
  */
-require_once('vendor/autoload.php');
-require_once('config.php');
+require_once 'vendor/autoload.php';
+require_once 'config.php';
 
 /**
  * site id of the AP to update

examples/auth_guest_basic.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the MAC address of the device to authorize

examples/auth_guest_with_note.php

@@ -11,13 +11,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the MAC address of the device to authorize

examples/block_list.php

@@ -11,19 +11,18 @@
  *
  * example:
  *  php block_list.php 09:09:09:09:09:09,10:10:10:10:10:10
- *
  */
 
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 $debug = false;
 
 /**
@@ -47,7 +46,7 @@ $unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $
 $set_debug_mode   = $unifi_connection->set_debug($debug);
 $loginresults     = $unifi_connection->login(); // always true regardless of site id
 
-foreach ($macs_to_block as &$mac) {
+foreach ($macs_to_block as $mac) {
     // block_result is always true even if mac address does not exist :(
     $block_result = $unifi_connection->block_sta($mac);
 

examples/change_super_mgmt.php

@@ -10,7 +10,7 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+require_once 'vendor/autoload.php';
 
 /**
  * UniFi controller credentials and the site to use, in this case since we are modifying global settings you can select
@@ -18,7 +18,7 @@ require_once('vendor/autoload.php');
  *
  * NOTE: in this case you need to enter Super Administrator account credentials in config.php
  */
-require_once('config.php');
+require_once 'config.php';
 $site_id = 'default';
 $debug   = false;
 

examples/change_wlan_password.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * The site to which the WLAN you want to modify belongs

examples/config.template.php

@@ -1,10 +1,8 @@
 <?php
 /**
- * Copyright (c) 2017, Art of WiFi
- *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
+ * Copyright (c) 2021, Art of WiFi
  *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**

examples/create_site.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/create_voucher.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * minutes the voucher is valid after activation (expiration time)

examples/delete_site.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/disable_device.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the 24 character id of the device to disable/enable

examples/disable_switch_port.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example PHP script to disable/enable the port of a UniFi switch
+ * note:           Requires controller version 5.5.X or higher. This example assumes an override alreay exists for the desired port.
+ *                 To create a new port override simply append one (similar in structure to $updated_override) as needed to the
+ *                 $existing_overrides array
+ */
+
+/**
+ * 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 to log in to the controller
+ */
+$site_id = '<enter your site id here>';
+
+/**
+ * the MAC address of the UniFi switch to re-configure
+ */
+$device_mac = '<enter MAC address>';
+
+/**
+ * index of port to modify/add
+ */
+$port_idx = 24;
+
+/**
+ * port configuration id to apply when enabling/disabling the port
+ *
+ * NOTE:
+ * port configurations are available through list_portconf()
+ */
+$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);
+$set_debug_mode     = $unifi_connection->set_debug($debug);
+$loginresults       = $unifi_connection->login();
+$data               = $unifi_connection->list_devices($device_mac);
+$device_id          = $data[0]->device_id;
+$existing_overrides = $data[0]->port_overrides;
+
+foreach ($existing_overrides as $key => $value) {
+    if (!empty($value->port_idx) && $value->port_idx === $port_idx) {
+        $updated_override = [
+            'portconf_id' => $port_conf_id,
+            'port_idx'    => $port_idx,
+            'poe_mode'    => $value->poe_mode,
+            'name'        => 'Your-port-name',
+        ];
+
+        $existing_overrides[$key] = $updated_override;
+    }
+}
+
+$payload = [
+    'port_overrides' => $existing_overrides
+];
+
+$update_device = $unifi_connection->set_device_settings_base($device_id, $payload);
+
+/**
+ * provide feedback in json format
+ */
+echo json_encode($update_device, JSON_PRETTY_PRINT);

examples/execute_custom_api_request.php

@@ -10,13 +10,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * The site to authorize the device with
@@ -28,7 +28,7 @@ $site_id = '<enter your site id here>';
  * parameters
  */
 $url            = '/api/s/' . $site_id . '/stat/fwupdate/latest-version';
-$request_type = 'GET';
+$request_method = 'GET';
 $payload        = null;
 $return         = 'array';
 
@@ -38,7 +38,7 @@ $return       = 'array';
 $unifi_connection = new UniFi_API\Client($controlleruser, $controllerpassword, $controllerurl, $site_id, $controllerversion);
 $set_debug_mode   = $unifi_connection->set_debug($debug);
 $loginresults     = $unifi_connection->login();
-$results          = $unifi_connection->custom_api_request($url, $request_type, $payload, $return);
+$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

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * must be adapted to your site!

examples/list_alarms.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use

examples/list_ap_connected_users.php

@@ -10,13 +10,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the short name of the site which you wish to query

examples/list_connected_users.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the short name of the site which you wish to query

examples/list_site_health.php

@@ -10,13 +10,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the short name of the site you wish to query

examples/list_sites.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example basic PHP script to list all site on the controller that are
+ *                 available to the admin account defined in config.php
+ */
+
+/**
+ * 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';
+
+/**
+ * we use the default site in the initial connection
+ */
+$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);
+$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
+ */
+//echo json_encode($data, JSON_PRETTY_PRINT);
+
+/**
+ * or we print each site name and site id
+ */
+foreach ($data as $site) {
+    echo 'Site name: ' . $site->desc . ', site id: ' . $site->name . PHP_EOL;
+}
+
+echo PHP_EOL;

examples/list_social_auth_details.php

@@ -10,13 +10,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use

examples/list_user_stats.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use

examples/modify_smartpower_pdu_outlet.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * PHP API usage example
+ *
+ * contributed by: Art of WiFi
+ * description:    example basic PHP script to toggle power of an outlet on the UniFi SmartPower PDU Pro,
+ *                 last tested with UniFi controller version 6.1.19
+ */
+require '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 = 'default';
+
+/**
+ * MAC of UniFi SmartPower PDU Pro to work with
+ */
+$pdu_mac = '<MAC ADDRESS of PDU>';
+
+/**
+ * index value of the outlet to modify
+ */
+$outlet_idx = 20;
+
+/**
+ * new values for relay_state (enable/disable Power) and cycle_enabled (disable/enable Modem Power Cycle) for the above outlet,
+ * values must be boolean (true/false)
+ *
+ * NOTES:
+ * - here you can choose to also change the name of the outlet
+ * - outlet overrides are structured like this:
+ *    {
+ *        "index": 1,
+ *        "name": "USB Outlet 1",
+ *        "cycle_enabled": false,
+ *        "relay_state": true
+ *    }
+ */
+$new_relay_state   = true;
+$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);
+$set_debug_mode   = $unifi_connection->set_debug($debug);
+$loginresults     = $unifi_connection->login();
+if ($loginresults) {
+    $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);
+        echo PHP_EOL;
+    } else {
+        echo 'not a PDU device?';
+        echo PHP_EOL;
+    }
+} else {
+    echo 'we encountered a login error!';
+    echo PHP_EOL;
+}

examples/reconnect_client.php

@@ -9,13 +9,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the MAC address to reconnect

examples/test_connection.php

@@ -11,7 +11,7 @@
  * see the config.template.php file for an example.
  * (will only be used here to get the URL to the controller)
  */
-require_once('config.php');
+require_once 'config.php';
 
 /**
  * Check whether the cURL module supports SSL

examples/toggle_led.php

@@ -10,13 +10,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * site id to use

examples/unblock_list.php

@@ -17,13 +17,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 $debug = false;
 
 /**

examples/update_ac-iw_ports.php

@@ -11,13 +11,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/update_device_wlan_settings_5.5.X.php

@@ -10,13 +10,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller

examples/update_switch_poe-mode.php

@@ -13,13 +13,13 @@
 /**
  * using the composer autoloader
  */
-require_once('vendor/autoload.php');
+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');
+require_once 'config.php';
 
 /**
  * the site to use to log in to the controller