UniFi Controller API client class

UniFi Controller API client class

This PHP class is maintained by Art of WiFi and provides access to Ubiquiti’s UniFi Controller API, supporting versions 5.X.X, 6.X.X, and 7.X.X, including version 7.2.95.

It is a standalone version of the class, which is also used in our API browser tool. Since its official release in September 2017, it has become the most popular API client for the UniFi controller platform, with over 890 GitHub and Packagist stars and more than 68000 downloads or clones.

The class can be installed manually or through composer and is available under the MIT license. It can be downloaded from GitHub here:
https://github.com/Art-of-WiFi/UniFi-API-browser

or through Packagist here:
https://packagist.org/packages/art-of-wifi/unifi-api-client

Methods and functions supported

The class currently supports the following functions/methods and more to get/post/put/delete data through the UniFi Controller API:

  • login()
  • logout()
  • adopt_device()
  • archive_alarm()
  • assign_existing_admin()
  • authorize_guest()
  • block_sta()
  • cancel_rolling_upgrade()
  • check_controller_update()
  • check_firmware_update()
  • cmd_stat()
  • count_alarms()
  • 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_client_name()
  • 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_device_name_mappings()
  • list_devices()
  • 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_full_status()
  • 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_monthly_aps()
  • stat_monthly_gateway()
  • stat_monthly_site()
  • stat_monthly_user()
  • stat_payment()
  • stat_sessions()
  • stat_sites()
  • stat_speedtest_results()
  • 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()

Other functions, getters/setters:

  • get_class_version()
  • get_cookie() (renamed from getcookie(), deprecated but still available, use get_cookies() instead)
  • get_cookies()
  • get_curl_connection_timeout()
  • get_curl_http_version()
  • get_curl_method()
  • get_curl_request_timeout()
  • get_curl_request_timeout()
  • get_curl_ssl_verify_host()
  • get_curl_ssl_verify_peer()
  • get_debug()
  • get_is_unifi_os()
  • get_last_error_message()
  • get_last_results_raw()
  • get_site()
  • set_connection_timeout()
  • set_cookies()
  • set_curl_http_version()
  • set_curl_request_timeout()
  • set_curl_ssl_verify_host()
  • set_curl_ssl_verify_peer()
  • set_debug()
  • set_is_unifi_os()
  • set_request_method()
  • set_request_timeout()
  • set_site()