mirror of
https://github.com/Art-of-WiFi/UniFi-API-client.git
synced 2024-11-24 19:20:20 +01:00
bf3446bba0
- 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
42 lines
1.1 KiB
PHP
Executable File
42 lines
1.1 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* PHP API usage example
|
|
*
|
|
* contributed by: Art of WiFi
|
|
* description: example basic PHP script to delete a site, 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 site to use to log in to the controller
|
|
*/
|
|
$site_id = '<short site name of a site the credentials used have access to>';
|
|
|
|
|
|
/**
|
|
* the site to delete, must not be the same site as referenced by $site_id
|
|
*/
|
|
$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);
|
|
$loginresults = $unifi_connection->login();
|
|
$results = $unifi_connection->delete_site($site_to_delete);
|
|
|
|
/**
|
|
* provide feedback in json format
|
|
*/
|
|
echo json_encode($results, JSON_PRETTY_PRINT);
|