The WiNG API provides the following top level paths to fetch data and configure various parameters.
Configuration URIs: Read and modify device configuration
| Path | Description |
|---|---|
| /v1/cfg/wlan/ | This path serves all resource requests and initiates all configuration operations on the WLAN entity. |
| /v1/cfg/device/ | This path serves all resource requests and initiates all configuration operations on the device entity. |
| /v1/cfg/profile/ | This path serves all resource requests and initiates all configuration operations on the profile entity. |
| /v1/cfg/management_policy/ | This path serves all resource requests and initiates all configuration operations on the management policy entity. |
| /v1/cfg/smart_rf_policy/ | This path serves all resource requests and initiates all configuration operations on the smart-rf policy entity. |
| /v1/cfg/captive_portal/ | This path serves all resource requests and initiates all configuration operations on the captive portal entity. |
| /v1/cfg/dns_whitelist/ | This path serves all resource requests and initiates all configuration operations on the DNS whitelist entity. |
| /v1/cfg/wips_policy/ | This path serves all resource requests and initiates all configuration operations on the WIPS policy entity. |
| /v1/cfg/aaa_policy/ | This path serves all resource requests and initiates all configuration operations on the AAA policy entity. |
| /v1/cfg/ip_acl/ | This path serves all resource requests and initiates all configuration operations on the IPv4 access list entity. |
| /v1/cfg/app_policy | This path serves all resource requests and initiates all configuration operations on the application policy entity. |
| /v1/cfg/mac_acl/ | This path serves all resource requests and initiates all configuration operations on the MAC access list entity. |
Action URIs: Perform Actions (Such as: login/logout, commit, save, revert, upgrade, and more)
| Path | Description |
|---|---|
| /v1/act/login | This path allows you to create a new session. |
| /v1/act/logout | This path allows you to close the session identified by auth_token. |
| /v1/act/commit | This path allows you to commit the configuration changes made in the session. |
| /v1/act/revert | This path allows you to revert the configuration changes made in the session. |
| /v1/act/wrmem | This path allows you to write the committed configuration to persistent storage. |
| /v1/act/upgrade | This path allows you to upgrade the software image. |
| /v1/act/disassociate-client | This path allows you to disassociate the wireless client(s). |
| /v1/act/device-upgrade | This path allows you to upgrade adopted devices. |
| /v1/act/device-upgrade-cancel | This path allows you to cancel upgrading a device. |
| /v1/act/load-device-upgrade-image | This path allows you to load the device images to controller for device upgrades. |
| /v1/act/clear-device-upgrade-history | This path allows you to clear the device upgrade history. |
| /v1/act/file-read | This path allows you to read files from flash directory; startup-config from nvram or copy running-config. |
| /v1/act/file-copy | This path allows you to copy files from flash directory; startup-config from nvram or copy running-config. |
| /v1/act/clone | This path allows you to clone an existing top-level configuration object. |
| /v1/act/rename | This path allows you to rename an existing top-level configuration object. |
| /v1/act/replace | This path allows you to replace a device configuration object. |
| /v1/act/copy-techsupport | This path allows you to copy extensive system information useful to technical support. |
| /v1/act/debug-wireless-clients | This path allows you to copy wireless debug messages on a remote device or devices in an rf-domain. |
| /v1/act/debug-captive-portal-clients | This path allows you to copy captive portal client messages on a remote device or devices in an rf-domain. |
| /v1/act/live-pktcap | This path allows you to initiate live packet capture on a remote device or devices in an rf-domain. |
| /v1/act/show-remote-debug-sessions | This path allows you to retrieve details of remote debug sessions. |
| /v1/act/end-remote-debug-sessions | This path allows you to end remote debug sessions. |
Statistics URIs: Retrieve Statistics and Runtime Information
| Path | Description |
|---|---|
| /v1/stats/wireless/radio | This path allows you to retrieve information about wireless radios for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/wireless/client | This path allows you to retrieve information about wireless clients for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/wireless/client-stats | This path allows you to retrieve wireless client statistics for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/wireless/radio-stats | This path allows you to retrieve wireless radio statistics for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/wireless/ap-info | This path allows you to retrieve information about wireless-managed access points for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/mint/links | This path allows you to retrieve information about mint links for the device executing the REST call or another specified device. |
| /v1/stats/mint/neighbors | This path allows you to retrieve information about mint neighbors for the device executing the REST call or another specified device. |
| /v1/stats/noc/domains | This path allows you to retrieve information about all domains for the device executing the REST call. |
| /v1/stats/noc/devices | This path allows you to retrieve information about devices in the network for the device executing the REST call. |
| /v1/stats/adoption/status | This path allows you to retrieve adoption status information for the device executing the REST call or another specified device. |
| /v1/stats/device | This path allows you to retrieve information about the device executing the REST call. |
| /v1/stats/event-history | This path allows you to retrieve information about event history for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/cdp-neighbors | This path allows you to retrieve information about CDP neighbors for the device executing the REST call or another specified device. |
| /v1/stats/lldp-neighbors | This path allows you to retrieve information about LLDP neighbors for the device executing the REST call or another specified device. |
| /v1/stats/dhcp-vendor-opts | This path allows you to retrieve information about DHCP options for the device executing the REST call or another specified device. |
| /v1/stats/captive-portal/sessions | This path allows you to retrieve information about captive portal sessions for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/gre/info | This path allows you to retrieve general information about GRE tunnels for the device executing the REST call or another specified device. |
| /v1/stats/gre/detail | This path allows you to retrieve detailed information about GRE tunnels for the device executing the REST call or another specified device. |
| /v1/stats/l2tpv3_stats/l2tpv3_tunnels | This path allows you to retrieve information about L2TPv3 tunnels for the device executing the REST call or another specified device. |
| /v1/stats/l2tpv3_stats/l2tpv3_tunnel_summary | This path allows you to retrieve a summary of L2TPv3 tunnels for the device executing the REST call or another specified device. |
| /v1/stats/System/upgrade-status | This path allows you retrieve information about last upgrade for the device executing the REST call or another specified device. |
| /v1/stats/Device-upgrade/load-image-status | This path allows you retrieve status of the firmware file download for the device executing the REST call or another specified device. |
| /v1/stats/Device-upgrade/status | This path allows you retrieve status of the device upgrade for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/Device-upgrade/history | This path allows you retrieve history of the device upgrade for the device executing the REST call, a rf-domain, or another specified device. |
| /v1/stats/Device-upgrade/versions | This path allows you retrieve versions of device upgrade images for the device executing the REST call, a rf-domain, or another specified device. |
Print
this page
Email this topic
Feedback
View PDF
Download EPUB