art-of-wifi/unifi-api-client

API client class for use with Ubiquiti's UniFi controller

v1.1.40 2019-01-21 08:41 UTC

README

A PHP class which provides access to Ubiquiti's UniFi SDN Controller API, versions 4.X.X and 5.X.X of the UniFi SDN Controller software are supported (version 5.10.5 has been confirmed to work). It's a standalone version of the class which is used in our API browser tool which can be found here.

This class can be installed manually or using composer/packagist 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.10 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

Installation

You can use Composer, Git or simply Download the Release to install the API client class.

Composer

The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.

Once composer is installed, simply execute this command from the shell in your project directory:

composer require art-of-wifi/unifi-api-client

Or you can manually add the package to your composer.json file:

{
    "require": {
        "art-of-wifi/unifi-api-client": "^1.1"
    }
}

Finally, be sure to include the autoloader in your code:

require_once('vendor/autoload.php');

Git

Execute the following git command from the shell in your project directory:

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:

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, uncompress the zip file, then include the file containing the class in your code like so:

require_once('path/to/src/Client.php');

Example usage

A basic example how to use the class:

/**
 * load the class using the composer autoloader
 */
require_once('vendor/autoload.php');

/**
 * 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);
$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.

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:

    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, and which is associated with the FQDN of the server as used in the controller_url parameter. This option was added with API client version 1.1.16.

Methods and functions 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.

  • login()
  • logout()
  • adopt_device()
  • archive_alarm()
  • authorize_guest()
  • block_sta()
  • count_alarms()
  • create_firewallgroup()
  • create_hotspotop()
  • create_network()
  • create_radius_account()
  • create_site()
  • create_usergroup()
  • create_user()
  • create_voucher()
  • create_wlan()
  • delete_device()
  • delete_firewallgroup()
  • delete_network()
  • delete_radius_account()
  • delete_site()
  • delete_usergroup()
  • delete_wlan()
  • disable_ap()
  • edit_client_fixedip()
  • edit_firewallgroup()
  • edit_usergroup()
  • extend_guest_validity()
  • forget_sta() (supported on controller version 5.9.X and higher)
  • invite_admin()
  • revoke_admin()
  • led_override()
  • list_admins()
  • list_all_admins()
  • list_alarms()
  • list_aps() (deprecated but still available as alias)
  • list_backups()
  • list_clients()
  • list_country_codes()
  • list_current_channels()
  • list_dashboard()
  • list_devices()
  • list_dpi_stats()
  • list_dynamicdns()
  • list_events()
  • list_extension()
  • list_firewallgroups()
  • list_guests()
  • list_health()
  • list_hotspotop()
  • list_known_rogueaps()
  • list_networkconf()
  • list_portconf()
  • list_portforward_stats()
  • list_portforwarding()
  • list_radius_accounts() (supported on controller version 5.5.19 and higher)
  • list_radius_profiles()
  • list_rogueaps()
  • list_self()
  • list_settings()
  • list_sites()
  • list_tags() (supported on controller version 5.5.19 and higher)
  • list_usergroups()
  • list_users()
  • list_wlan_groups()
  • list_wlanconf()
  • locate_ap()
  • move_device()
  • power_cycle_switch_port()
  • reconnect_sta()
  • rename_ap()
  • restart_ap()
  • revoke_voucher()
  • set_ap_radiosettings()
  • set_device_settings_base()
  • set_guestlogin_settings()
  • set_guestlogin_settings_base()
  • set_ips_settings_base() (supported on controller version 5.9.10 and higher)
  • set_locate_ap() (deprecated but still available as alias)
  • set_networksettings_base()
  • set_radius_account_base()
  • set_site_connectivity()
  • set_site_country()
  • set_site_guest_access()
  • set_site_locale()
  • set_site_mgmt()
  • set_site_name()
  • set_site_ntp()
  • set_site_snmp()
  • set_sta_name()
  • set_sta_note()
  • set_usergroup()
  • set_wlan_mac_filter()
  • 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()
  • 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_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_sysinfo()
  • stat_voucher()
  • 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:

  • set_debug()
  • get_debug()
  • set_site()
  • get_site()
  • get_cookie() (renamed from getcookie())
  • get_last_results_raw()
  • get_last_error_message()

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 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 done by the following developers:

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.