Skip to content

Commit

Permalink
updated README.md for API client class
Browse files Browse the repository at this point in the history
updated README.md for API client class to reflect the changed
functions/methods  locate_ap() and site_leds(), which replace
site_ledson()/site_ledsoff() and
unset_locate_ap()/set_locate_ap()
  • Loading branch information
malle-pietje committed Apr 22, 2017
1 parent 9125e45 commit 6307568
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions phpapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,21 @@
This directory contains a PHP class, which is based off the work of @domwo and @fbagnol and the API shell client as published by UBNT.

The class currently supports the following functions/methods to get/set data through the UniFi controller API:

- login()
- logout()
- get_last_results_raw()
- add_site()
- adopt_device()
- authorize_guest()
- unauthorize_guest()
- block_sta()
- unblock_sta()
- create_hotspotop()
- create_voucher()
- delete_site($site_id)
- delete_site()
- disable_ap()
- led_override()
- list_admins($description)
- list_admins()
- list_alarms()
- list_aps()
- list_clients()
Expand Down Expand Up @@ -45,15 +47,18 @@ The class currently supports the following functions/methods to get/set data thr
- extend_guest_validity()
- set_ap_radiosettings()
- set_guestlogin_settings()
- set_locate_ap()
- locate_ap()
- set_locate_ap() (deprecated but still available as alias)
- unset_locate_ap() (deprecated but still available as alias)
- set_sta_name()
- set_sta_note()
- set_usergroup()
- set_wlansettings()
- create_wlan()
- delete_wlan()
- site_ledsoff()
- site_ledson()
- site_leds()
- site_ledsoff() (deprecated but still available as alias)
- site_ledson() (deprecated but still available as alias)
- stat_allusers()
- stat_auths()
- stat_client()
Expand All @@ -67,9 +72,6 @@ The class currently supports the following functions/methods to get/set data thr
- stat_sta_sessions_latest()
- stat_sysinfo()
- stat_voucher()
- unauthorize_guest()
- unblock_sta()
- unset_locate_ap()

Please refer to the source code for more details on each function/method and it's parameters.

Expand Down

0 comments on commit 6307568

Please sign in to comment.