Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
products:software:unifi-controller:api [2019/08/01 14:12]
psychodata Add Migrate Commands, useful for bulk Inform changes
products:software:unifi-controller:api [2019/12/06 10:07] (current)
henryguo [Table]
Line 36: Line 36:
 All commands are presumed to be prefixed with `api/​s/​{site}` All commands are presumed to be prefixed with `api/​s/​{site}`
  
-^ Path                  ^ Method ​       ^ Notes                                                                                                            +^ Path                           ​^ Method ​       ^ Notes                                                                                                                                                                                                                                                                                                      
-| stat/​health ​          ​| GET           | Health status of the site                                                                                        +| stat/​health ​                   | GET           | Health status of the site                                                                                                                                                                                                                                                                                  
-| self                  | GET           | Logged in user                                                                                                   ​+| self                           ​| GET           | Logged in user                                                                                                                                                                                                                                                                                             ​
-| stat/​ccode ​           | GET           | List of country codes                                                                                            +| stat/​ccode ​                    ​| GET           | List of country codes                                                                                                                                                                                                                                                                                      
-| stat/​current-channel ​ | GET           | List of all RF channels based on the site country code                                                           ​+| stat/​current-channel ​          ​| GET           | List of all RF channels based on the site country code                                                                                                                                                                                                                                                     ​
-| stat/​sysinfo ​         | GET           | Some high-level information about the controller ​                                                                ​+| stat/​sysinfo ​                  ​| GET           | Some high-level information about the controller ​                                                                                                                                                                                                                                                          ​
-| stat/​event ​           | GET           | List site events by most recent first, 3000 result limit                                                         ​+| stat/​event ​                    ​| GET           | List site events by most recent first, 3000 result limit                                                                                                                                                                                                                                                   ​
-| rest/​event ​           | GET           | List site events by oldest, no limit? ​                                                                           +| rest/​event ​                    ​| GET           | List site events by oldest, no limit? ​                                                                                                                                                                                                                                                                     
-| stat/​alarm ​           | GET           | List alarms by most recent, 3000 result limit? ​                                                                  ​+| stat/​alarm ​                    ​| GET           | List alarms by most recent, 3000 result limit? ​                                                                                                                                                                                                                                                            ​
-| rest/​alarm ​           | GET           | List alarms by oldest, no limit? ​                                                                                ​+| rest/​alarm ​                    ​| GET           | List alarms by oldest, no limit? ​                                                                                                                                                                                                                                                                          ​
-| stat/​sta ​             | GET           | List of all _active_ clients on the site                                                                         ​+| stat/​sta ​                      ​| GET           | List of all _active_ clients on the site                                                                                                                                                                                                                                                                   ​
-| rest/​user ​            ​| GET/​POST/​PUT ​ | List of all configured/​known clients on the site                                                                 ​+| rest/​user ​                     | GET/​POST/​PUT ​ | List of all configured/​known clients on the site                                                                                                                                                                                                                                                           ​
-| stat/​device-basic ​    ​| GET           | List of site devices with only '​adopted',​ '​disabled',​ '​mac',​ '​state',​ '​type'​ keys, useful for filtering on type  +| stat/​device-basic ​             | GET           | List of site devices with only '​adopted',​ '​disabled',​ '​mac',​ '​state',​ '​type'​ keys, useful for filtering on type                                                                                                                                                                                            
-| stat/​device ​          ​| GET/​POST ​     | Detailed list of all devices on site.  Can be filtered by posting `{"​macs":​ ["​mac1",​ ... ]}`                     ​+| stat/​device ​                   | GET/​POST ​     | Detailed list of all devices on site.  Can be filtered by posting `{"​macs":​ ["​mac1",​ ... ]}`                                                                                                                                                                                                               ​
-| rest/​device/​{_id} ​    ​| PUT           | Updates to devices get PUT here, why?                                                                            +| rest/​device/​{_id} ​             | PUT           | Updates to devices get PUT here, why?                                                                                                                                                                                                                                                                      
-| rest/​setting ​         | GET/​PUT ​      | Detailed site settings, updating requires adding key and _id to path for PUT                                     ​+| rest/​setting ​                  ​| GET/​PUT ​      | Detailed site settings, updating requires adding key and _id to path for PUT                                                                                                                                                                                                                               ​
-| stat/​routing ​         | GET           | All active routes on the device ​                                                                                 +| stat/​routing ​                  ​| GET           | All active routes on the device ​                                                                                                                                                                                                                                                                           
-| rest/​routing ​         | GET/​PUT ​      | User defined routes ​                                                                                             +| rest/​routing ​                  ​| GET/​PUT ​      | User defined routes ​                                                                                                                                                                                                                                                                                       
-| rest/​firewallrule ​    ​| GET/​PUT ​      | User defined firewall rules. ​ This does not show auto-generated rules                                            +| rest/​firewallrule ​             | GET/​PUT ​      | User defined firewall rules. ​ This does not show auto-generated rules                                                                                                                                                                                                                                      
-| rest/​firewallgroup ​   | GET/​PUT ​      | User defined firewall groups. ​                                                                                   +| rest/​firewallgroup ​            ​| GET/​PUT ​      ​| ​User defined firewall groups. ​                                                                                                                                                                                                                                                                            | 
-| rest/​tag ​             | GET/​PUT? ​     | Tagged macs                                                                                                      +| rest/​wlanconf ​                 | GET/​PUT ​      | List WLANs, edit current WLANs and create new WLANs                                                                                                                                                                                                                                                        ​
-| stat/​rogueap ​         | GET/​POST ​     | Neighboring APs optional json post '​within'​ = seen in the last x hours                                           ​+| rest/​tag ​                      ​| GET/​PUT? ​     | Tagged macs                                                                                                                                                                                                                                                                                                
-| stat/​sitedpi ​         | GET/​POST ​     | DPI stats requires type="​by_app"​ or "​by_cat"​ | +| stat/​rogueap ​                  ​| GET/​POST ​     | Neighboring APs optional json post '​within'​ = seen in the last x hours                                                                                                                                                                                                                                     ​
-| stat/​stadpi ​          ​| GET/​POST ​     | DPI stats requires type="​by_app"​ or "​by_cat"​ optionally filtered macs=[..., ] | +| stat/​sitedpi ​                  ​| GET/​POST ​     | DPI stats requires type="​by_app"​ or "​by_cat" ​                                                                                                                                                                                                                                                              ​
-| stat/​dynamicdns ​      ​| GET           | DynamicDNS information and status like current ip, last changed, and status ​ +| stat/​stadpi ​                   | GET/​POST ​     | DPI stats requires type="​by_app"​ or "​by_cat"​ optionally filtered macs=[..., ]                                                                                                                                                                                                                              
-| rest/​dynamicdns ​      ​| GET/​PUT ​      | DynamicDNS configuration | +| stat/​dynamicdns ​               | GET           | DynamicDNS information and status like current ip, last changed, and status ​                                                                                                                                                                                                                               
-| rest/​portconf ​        ​| GET           | Switch port profiles | +| rest/​dynamicdns ​               | GET/​PUT ​      | DynamicDNS configuration ​                                                                                                                                                                                                                                                                                  ​
-| stat/​spectrumscan ​    ​| GET           | Get RF scan results, can be for a specific mac by appending to endpoint | +| rest/​portconf ​                 | GET           | Switch port profiles ​                                                                                                                                                                                                                                                                                      ​
-| rest/​radiusprofile ​   | GET/​POST/​PUT ​ | Radius profiles | +| stat/​spectrumscan ​             | GET           | Get RF scan results, can be for a specific mac by appending to endpoint ​                                                                                                                                                                                                                                   
-| rest/​account ​         | GET/​POST/​PUT ​ | Radius accounts | +| rest/​radiusprofile ​            ​| GET/​POST/​PUT ​ | Radius profiles ​                                                                                                                                                                                                                                                                                           
-| rest/​portforward ​     | GET           | List all port forwards configured on the site | +| rest/​account ​                  ​| GET/​POST/​PUT ​ | Radius accounts ​                                                                                                                                                                                                                                                                                           
-| stat/​report/​{interval}.{type} ​  ​| POST | Intervals are '​5minutes',​ '​hourly',​ and '​daily'​. ​ Report types are '​site',​ '​user',​ and '​ap'​. ​ Must specify attributes to be returned '​bytes',​ '​wan-tx_bytes',​ '​wan-rx_bytes',​ '​wlan_bytes',​ '​num_sta',​ '​lan-num_sta',​ '​wlan-num_sta',​ '​time',​ '​rx_bytes',​ '​tx_bytes'​. ​ Can be filtered with '​macs':​ [...] |+| rest/​portforward ​              ​| GET           | List all port forwards configured on the site                                                                                                                                                                                                                                                              
 +| stat/​report/​{interval}.{type} ​ | POST          | Intervals are '​5minutes',​ '​hourly',​ and '​daily'​. ​ Report types are '​site',​ '​user',​ and '​ap'​. ​ Must specify attributes to be returned '​bytes',​ '​wan-tx_bytes',​ '​wan-rx_bytes',​ '​wlan_bytes',​ '​num_sta',​ '​lan-num_sta',​ '​wlan-num_sta',​ '​time',​ '​rx_bytes',​ '​tx_bytes'​. ​ Can be filtered with '​macs':​ [...]  |
  
  
Line 74: 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.1564683124.txt.gz
  • Last modified: 2019/08/01 14:12
  • by psychodata