unifi-php-api/README.md

UniFi Controller API client class

A PHP class that provides access to Ubiquiti's UniFi Network Controller 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.

The package can be installed manually or by using composer/packagist for easy inclusion in your projects.

Requirements

• 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 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

Use Composer, Git or simply Download the Release to install the API client class.

Composer

The preferred installation method is through composer. Follow these 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 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, 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 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 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.

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 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_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()
• delete_radius_account()
• delete_site()
• 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()
• led_override()
• list_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()
• list_country_codes()
• 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()
• 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_routing()
• 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()
• reboot_cloudkey()
• reconnect_sta()
• rename_ap()
• restart_ap() (deprecated but still available as alias)
• restart_device()
• 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)
• 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_super_identity_settings_base()
• set_super_mgmt_settings_base()
• set_super_smtp_settings_base()
• 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()
• 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_daily_aps()
• stat_daily_gateway() (supported on controller version 5.7.X and higher)
• stat_daily_site()
• 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_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()

Other functions, getters/setters:

• get_class_version()
• get_connection_timeout()
• get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
• get_cookies()
• get_debug()
• 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 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:

• domwo: http://community.ubnt.com/t5/UniFi-Wireless/little-php-class-for-unifi-api/m-p/603051
• fbagnol: https://github.com/fbagnol/class.unifi.php

and the API as published by Ubiquiti:

• https://dl.ui.com/unifi/6.0.41/unifi_sh_api

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.