API client class v1.1.81

- hotfix to address cookie issues in UniFi OS 3.2.7, reported by @tflatebo
- fixed minor typos
- minor code reformatting of the examples
- starting with this release, cookies are no longer supported when connecting to a UniFi OS-based controller
- added set_vlan_to_port.php example, contributed by @SamuelSchnelly, #203
- allow additional parameters in `create_wlan()`'s payload, contributed by @sgrodzicki, #191

README.md

@@ -35,6 +35,9 @@ The class automatically detects UniFi OS-based controllers and adjusts URLs and
 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.
 
+> **IMPORTANT NOTE**: cookies are no longer supported with UniFi OS-based controllers. If your application code does use cookies,
+  they will be ignored automatically when working with UniFi OS-based controllers.
+
 Please test all methods you plan on using thoroughly before using the API Client with
 UniFi OS devices in a production environment.
 

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,7 +24,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $login = $unifi_connection->login();
 
 /**

examples/auth_guest_basic.php

@@ -45,7 +45,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 

examples/auth_guest_with_note.php

@@ -42,7 +42,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 

examples/block_list.php

@@ -42,7 +42,14 @@ 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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login(); // always true regardless of site id
 

examples/change_super_mgmt.php

@@ -25,7 +25,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 $site_settings  = $unifi_connection->list_settings();
@@ -34,7 +41,7 @@ $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;

examples/change_wlan_password.php

@@ -35,7 +35,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $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);

examples/create_site.php

@@ -30,7 +30,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $loginresults = $unifi_connection->login();
 $results      = $unifi_connection->create_site($description);
 

examples/create_voucher.php

@@ -35,7 +35,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 

examples/delete_site.php

@@ -31,7 +31,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $loginresults = $unifi_connection->login();
 $results      = $unifi_connection->delete_site($site_to_delete);
 

examples/disable_device.php

@@ -30,7 +30,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 

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,7 +35,14 @@ $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(
+    $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_method, $payload, $return);

examples/extend_guest_auth.php

@@ -23,7 +23,14 @@ 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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 
@@ -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,7 +26,14 @@ $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);
 $loginresults   = $unifi_connection->login();
 $aps_array      = $unifi_connection->list_aps();

examples/list_connected_users.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 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);
 $loginresults   = $unifi_connection->login();
 $clients_array  = $unifi_connection->list_clients();

examples/list_site_health.php

@@ -26,8 +26,14 @@ $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);
 $loginresults   = $unifi_connection->login();
 $result         = $unifi_connection->list_health();
@@ -36,4 +42,4 @@ $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,7 +26,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 $data           = $unifi_connection->list_sites();

examples/list_social_auth_details.php

@@ -26,7 +26,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->stat_payment();

examples/list_user_stats.php

@@ -38,7 +38,14 @@ $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(
+    $controlleruser,
+    $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);

examples/modify_smartpower_pdu_outlet.php

@@ -49,16 +49,33 @@ $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(
+    $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);
+if (!$loginresults) {
+    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')) {
+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;
 
@@ -69,19 +86,15 @@ if ($loginresults) {
         }
     }
 
-        $pdu_update = $unifi_connection->set_device_settings_base($device_id, ['outlet_overrides' => $outlet_overrides]);
+    $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;
+    echo 'not a PDU device?';
 }
+echo PHP_EOL;

examples/reconnect_client.php

@@ -30,7 +30,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 

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/toggle_led.php

@@ -31,7 +31,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login();
 

examples/unblock_list.php

@@ -43,7 +43,14 @@ 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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug($debug);
 $loginresults   = $unifi_connection->login(); // always true regardless of site id
 

examples/update_ac-iw_ports.php

@@ -60,7 +60,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug(false);
 $loginresults   = $unifi_connection->login();
 $data           = $unifi_connection->list_devices($device_mac);

examples/update_device_wlan_settings_5.5.X.php

@@ -51,7 +51,14 @@ $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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug(false);
 $loginresults   = $unifi_connection->login();
 $data           = $unifi_connection->list_devices($ap_mac);

examples/update_switch_poe-mode.php

@@ -42,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++){
-        if(in_array($running_config[$i]->port_idx, $ports)){
+    for ($i = 0; $i < $running_config_count; $i++) {
+        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
@@ -65,7 +66,14 @@ 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(
+    $controlleruser,
+    $controllerpassword,
+    $controllerurl,
+    $site_id,
+    $controllerversion
+);
+
 $set_debug_mode = $unifi_connection->set_debug(false);
 $loginresults   = $unifi_connection->login();
 $data           = $unifi_connection->list_devices($device_mac);

src/Client.php

@@ -13,7 +13,7 @@ namespace UniFi_API;
  *
  * @package UniFi_Controller_API_Client_Class
  * @author  Art of WiFi <info@artofwifi.net>
- * @version Release: 1.1.80
+ * @version Release: 1.1.81
  * @license This class is subject to the MIT license that is bundled with this package in the file LICENSE.md
  * @example This directory in the package repository contains a collection of examples:
  *          https://github.com/Art-of-WiFi/UniFi-API-client/tree/master/examples
@@ -23,15 +23,14 @@ class Client
     /**
      * private and protected properties
      *
-     * NOTE:
-     * do not modify the values here, instead use the constructor or the getter and setter functions/methods
+     * NOTE: do **not** modify the values here, instead use the constructor or the getter and setter functions/methods
      */
-    const CLASS_VERSION             = '1.1.80';
+    const CLASS_VERSION             = '1.1.81';
     protected $baseurl              = 'https://127.0.0.1:8443';
     protected $user                 = '';
     protected $password             = '';
     protected $site                 = 'default';
-    protected $version              = '6.2.26';
+    protected $version              = '7.3.76';
     protected $debug                = false;
     protected $is_logged_in         = false;
     protected $is_unifi_os          = false;
@@ -100,9 +99,9 @@ class Client
     public function __destruct()
     {
         /**
-         * if $_SESSION['unificookie'] is set, do not log out here
+         * if $_SESSION['unificookie'] is set, do not log out here except when this is a UniFi OS-based controller
          */
-        if (isset($_SESSION['unificookie'])) {
+        if (isset($_SESSION['unificookie']) && !$this->is_unifi_os) {
             return;
         }
 
@@ -1397,9 +1396,9 @@ class Client
     }
 
     /**
-     * List of site devices with a basic subset of fields (e.g., mac, state, adopted, disabled, type, model, name)
+     * List of UniFi devices with a basic subset of properties (e.g., mac, state, adopted, disabled, type, model, name)
      *
-     * @return array|false an array containing known UniFi device objects), false upon error
+     * @return array|false an array containing known UniFi device objects, false upon error
      */
     public function list_devices_basic()
     {
@@ -1409,7 +1408,7 @@ class Client
     /**
      * Fetch UniFi devices
      *
-     * @param string $device_mac optional, the MAC address of a single UniFi device for which the call must be made
+     * @param array|string $device_mac optional, the MAC address of a single UniFi device for which the call must be made
      * @return array|false an array containing known UniFi device objects (or a single device when using the <device_mac>
      *                     parameter), false upon error
      */
@@ -2625,6 +2624,7 @@ class Client
      * @param array   $schedule         optional, schedule rules
      * @param array   $ap_group_ids     optional, array of ap group ids, required for UniFi controller versions 6.0.X
      *                                  and higher
+     * @param array $payload            optional, array of additional parameters (wlan_bands, wpa3_support, etc.)
      * @return bool true on success
      */
     public function create_wlan(
@@ -2643,9 +2643,10 @@ class Client
         $uapsd_enabled = false,
         $schedule_enabled = false,
         $schedule = [],
-        $ap_group_ids = null
+        $ap_group_ids = null,
+        $payload = []
     ) {
-        $payload = [
+        $payload = array_merge($payload,[
             'name'             => trim($name),
             'usergroup_id'     => trim($usergroup_id),
             'wlangroup_id'     => trim($wlangroup_id),
@@ -2658,7 +2659,7 @@ class Client
             'uapsd_enabled'    => $uapsd_enabled,
             'schedule_enabled' => $schedule_enabled,
             'schedule'         => $schedule,
-        ];
+        ]);
 
         if (!empty($vlan_id)) {
             $payload['networkconf_id'] = $vlan_id;