Making Your First API Call

1. Download cURL for your environment.

   Tip

   If you use Windows, use a Bash shell to make cURL calls.
2. Log in to the REST API server using valid management user credentials.
   

   Note

   You must forward the auth_token as a cookie with each subsequent API call.
3. Use the GET method to access the cfg resource and fetch the specific WLAN configuration.

   Sample Request

   

   curl -X GET --cookie auth_token=$cookie https://10.190.50.43/rest/v1/cfg/wlan/test-1

   Sample Response (200 OK)

   

   {    
   "data":{        
   	"aaa_policy": "",        
   	"accounting_radius":false,        
   	"accounting_syslog":{            
   		"enable":false,            
   		"host": "",            
   		"mac_case": "upper",            
   		"mac_format": "pair-hyphen",            
   		"port": 514,            
   		"proxy_mode": "none"        
   	},        ..............        
   	"wpa_wpa2_handshake_timeout":[            
   		500,            
   		500,            
   		500,            
   		500        
   	],        
   	"wpa_wpa2_opmk_caching":true,        
   	"wpa_wpa2_pmk_caching":true,        
   	"wpa_wpa2_preauthentication":false,        
   	"wpa_wpa2_psk": "Z+eRSxI9kwENQ6svDyOBawAAAC58Tyzp/
   	VuvHsLVbmmuTkMatQ4pmt3YgTNij1W6Q2eQ9Am2KnYW9WZl4jJrxnSS5G8=",        
   	"wpa_wpa2_tkip_cntrmeas_hold_time": 60,        
   	"wpa_wpa2_use_sha256":false    
   	},    
   "return_code": 0
   }

   

   Response Definitions

   Response Item	Description	Data Type
   aaa_policy	The AAA policy name	String (1 to 32 characters)
   accounting_radius	A flag to enable/disable support for RADIUS accounting messages	Boolean
   accounting_syslog	Configuration of Syslog accounting messages	Object
   enable	A flag to enable/disable support for Syslog accounting messages	Boolean
   host	Syslog destination host name or IP address for accounting records	String
   mac_case	The case in which the MAC address is to be specified. Default is upper case.	Enumeration [lower,upper]
   mac_format	The format in which the MAC address must be filled in the syslog messages. Default is pair-hyphen.	Enumeration [no-delim, air-hyphen, quad-dot, middle-hyphen]
   port	UDP port number of the Syslog server	Integer (1 to 65535, default is 514)
   proxy_mode	Specifies whether the request is transmitted directly to the server or proxied through the controller or the RF Domain Manager. Default is none.	Enumeration [none, through-controller, through-rf-domain-manager]
   wpa_wpa2_handshake_timeout	The timeout (in milliseconds) on a handshake message, before it is retried	Integer (10 to 5000)
   wpa_wpa2_opmk_caching	A flag to enable/disable the use of Opportunistic Key Caching (same PMK across APs for fast roaming with 802.1X EAP)	Boolean
   wpa_wpa2_pmk_caching	A flag to enable/disable the use of cached pairwise master keys (fast roaming with 802.1X EAP)	Boolean
   wpa_wpa2_preauthentication	A flag to enable/disable the use of preauthentication (802.11i fast roaming)	Boolean
   wpa_wpa2_psk	Pre-shared key	String (8 to 63 characters)
   wpa_wpa2_tkip_cntrmeas_hold_time	The amount of time (in seconds) for which a WLAN is disabled when TKIP countermeasures are invoked	Integer (0 to 65535, default is 60)
   wpa_wpa2_use_sha256	A flag to enable/disable use of SHA256 authentication key management	Boolean