Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
products:software:unifi-controller:api [2019/09/11 13:01]
tertius Replace deleted value, added edit to list/create on previous.
products:software:unifi-controller:api [2019/12/06 10:07] (current)
henryguo [Table]
Line 75: Line 75:
 Posting to the endpoint `api/​s/​{site}/​cmd/<​manager>​` with the `json {"​cmd":​ "​command"​}` you can invoke commands on the controller. Posting to the endpoint `api/​s/​{site}/​cmd/<​manager>​` with the `json {"​cmd":​ "​command"​}` you can invoke commands on the controller.
  
-^ Manager ^ Call ^ Notes ^ +^ Manager ​ ^ Call                ^ Notes                                                                                    
-| evtmgt | archive-all-alarms | | +| evtmgt ​  ​| archive-all-alarms ​                                                                                          
-| sitemgr | add-site | desc = Descriptive name ( required ), name = shortname ( in the URL ) | +| sitemgr ​ | add-site ​           | desc = Descriptive name ( required ), name = shortname ( in the URL )                    
-| sitemgr | delete-site | name = short name ( required ) | +| sitemgr ​ | delete-site ​        ​| name = short name ( required )                                                           ​
-| sitemgr | update-site | desc = Descriptive name ( required ) | +| sitemgr ​ | update-site ​        ​| desc = Descriptive name ( required )                                                     ​
-| sitemgr | get-admins ​ | List all administrators and permission for this site | +| sitemgr ​ | get-admins ​         | List all administrators and permission for this site                                     ​
-| sitemgr | move-device | mac = device mac ( required ), site_id = 24 digit id ( required ) | +| sitemgr ​ | move-device ​        ​| mac = device mac ( required ), site_id = 24 digit id ( required )                        
-| sitemgr | delete-device | mac = device mac ( required ) | +| sitemgr ​ | delete-device ​      ​| mac = device mac ( required )                                                            
-| stamgr ​ | block-sta | mac = client mac ( required ) | +| stamgr ​  ​| block-sta ​          ​| mac = client mac ( required )                                                            
-| stamgr ​ | unblock-sta | mac = client mac ( required ) | +| stamgr ​  ​| unblock-sta ​        ​| mac = client mac ( required )                                                            
-| stamgr ​ | kick-sta | Disconnect: mac = client mac (required ) | +| stamgr ​  ​| kick-sta ​           | Disconnect: mac = client mac (required )                                                 ​
-| stamgr ​ | forget-sta | Forget a client ( controller 5.9.x only ) | +| stamgr ​  ​| forget-sta ​         | Forget a client ( controller 5.9.x only )                                                | 
-| devmgr ​ | adopt | mac = device mac ( required ) | +| stamgr ​  | unauthorize-guest ​  | Unauthorize a client device, mac = client mac (required) ​                                
-| devmgr ​ | restart | mac = device mac ( required ) | +| devmgr ​  ​| adopt               ​| mac = device mac ( required )                                                            
-| devmgr ​ | force-provision | mac = device mac ( required ) | +| devmgr ​  ​| restart ​            ​| mac = device mac ( required )                                                            
-| devmgr ​ | power-cycle | mac = switch mac ( required ), port_idx = PoE port to cycle ( required ) | +| devmgr ​  ​| force-provision ​    ​| mac = device mac ( required )                                                            
-| devmgr ​ | speedtest | Start a speed test | +| devmgr ​  ​| power-cycle ​        ​| mac = switch mac ( required ), port_idx = PoE port to cycle ( required )                 ​
-| devmgr ​ | speedtest-status | get the current state of the speed test | +| devmgr ​  ​| speedtest ​          ​| Start a speed test                                                                       ​
-| devmgr ​ | set-locate | mac = device mac ( required ) blink unit to locate | +| devmgr ​  ​| speedtest-status ​   | get the current state of the speed test                                                  
-| devmgr ​ | unset-locate | mac = device mac ( required ) led to normal state | +| devmgr ​  ​| set-locate ​         | mac = device mac ( required ) blink unit to locate ​                                      ​
-| devmgr ​ | upgrade | mac = device mac ( required ) upgrade firmware | +| devmgr ​  ​| unset-locate ​       | mac = device mac ( required ) led to normal state                                        
-| devmgr ​ | upgrade-external | mac = device mac ( required ), url = firmware URL ( required ) | +| devmgr ​  ​| upgrade ​            ​| mac = device mac ( required ) upgrade firmware ​                                          ​
-| devmgr ​ | migrate | mac = device mac ( required ), inform_url = New Inform URL to push to device (required) | +| devmgr ​  ​| upgrade-external ​   | mac = device mac ( required ), url = firmware URL ( required )                           ​
-| devmgr ​ | cancel-migrate | mac = device mac ( required ) | +| devmgr ​  ​| migrate ​            ​| mac = device mac ( required ), inform_url = New Inform URL to push to device (required) ​ 
-| devmgr ​ | spectrum-scan | mac = device mac ( ap only, required ) trigger RF scan | +| devmgr ​  ​| cancel-migrate ​     | mac = device mac ( required )                                                            
-| backup | list-backup | list of autobackup files | +| devmgr ​  ​| spectrum-scan ​      ​| mac = device mac ( ap only, required ) trigger RF scan                                   ​
-| backup | delete-backup | filename ( required ) | +| backup ​  ​| list-backup ​        ​| list of autobackup files                                                                 ​
-| system | backup | create a backup. ​ This appears to backup to a fixed location in the filesystem | +| backup ​  ​| delete-backup ​      ​| filename ( required )                                                                    
-| stat | clear-dpi | resets the site wide DPI counters |+| system ​  ​| backup ​             | create a backup. ​ This appears to backup to a fixed location in the filesystem ​          ​
 +| stat     ​| clear-dpi ​          ​| resets the site wide DPI counters ​                                                       |
  
  
  • products/software/unifi-controller/api.txt
  • Last modified: 2019/12/06 10:07
  • by henryguo