unifi-php-api/examples/disable_device.php
malle-pietje bf3446bba0 API client class v1.1.64
- added information to several docblocks
- changed handling of request headers, added private property for this
- applied changes for improved use of require_once in the README and examples
- added `list_sites()` example
- *potential breaking changes:*
    renamed `get_request_type()` and `set_request_type()` functions/methods to `get_request_method()` and `set_request_method()` respectively
2021-01-21 10:59:27 +01:00

51 lines
1.3 KiB
PHP
Executable File

<?php
/**
* PHP API usage example
*
* contributed by: Art of WiFi
* description: example basic PHP script to disable/enable a device, returns true upon success
*/
/**
* 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 24 character id of the device to disable/enable
*/
$device_id = '<enter the id of your device here>';
/**
* the site to which the device belongs
*/
$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);
$set_debug_mode = $unifi_connection->set_debug($debug);
$loginresults = $unifi_connection->login();
/**
* then we disable the device
*/
$disable_result = $unifi_connection->disable_ap($device_id, true);
/**
* or we enable the device, uncomment as neccesary (then also comment the previous call)
*/
//$disable_result = $unifi_connection->disable_ap($device_id, false);
/**
* provide feedback in json format
*/
echo json_encode($disable_result, JSON_PRETTY_PRINT);