Debug Captive Portal Clients

1. Log in to the REST API server using valid management user credentials.
   

   Note

   You must forward the auth_token as a cookie with each API call.
2. Use the POST method to access the /act/debug-captive-portal-clients/ URI and copy captive portal client messages.

   Sample Requests with Different Possible Input Parameters

   

   curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/debug-captive-portal-clients 
   -d
      '{"hosts":["ap7632-9AECDC"],"url":"ftp://username:password@172.16.0.60/captive-portal-debugs1.txt","debug_events":["all"]}'

   

   curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/debug-captive-portal-clients 
   -d
     '{"rf-domain":"default","url":"ftp://username:password@172.16.0.60/rfd-captive-portal-debugs1.txt","debug_events":["all"]}'

   

   curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/debug-captive-portal-clients 
   -d
      '{"hosts":["ap7632-9AECDC"],"url":"ftp://username:password@172.16.0.60/cp-debugs1.txt",
         "debug_events":["all"],"client_mac_list":["D0-04-01-3B-01-70","D0-04-01-3B-01-71","D0-04-01-3B-01-72",
           "D0-04-01-3B-01-73","D0-04-01-3B-01-74"]}'

   

   curl -X POST  --cookie auth_token=$cookie http://172.16.0.24/rest/v1/act/debug-captive-portal-clients 
   -d
      '{"hosts":["ap7632-9AECDC"],"url":"ftp://username:password@172.16.0.60/captive-portal-debugs1.txt",
         "debug_events":["all"],"duration":86400,"session_name":"one-day"}'

   

   Request Body Parameters

   Parameter	Description	Required/Optional	Data Type
   hosts	Name of the hosts separated by comma, for which the captive portal messages will be started	Optional.	String Array
   rf-domain	Name of the rf_domain for which the captive portal messages will be started	Optional	String
   Floor	Name of the floor belonging to the rf_domain	Optional.	String
   Area	Name of the area belonging to the rf_domain	Optional	String
   url	URL	Required	String
   session_name	Name to identify this session	Optional	String
   client_mac_list	List of client MAC addresses (maximum is 5)	Optional	String Array
   duration	Duration of the debug in seconds. Default value is 60.	Optional	Integer (1-864000)
   max_events	Maximum number of events to log per remote system. Default value is 50.	Optional	Integer (1-10000)
   debug_events	List of captive portal debug events	Required	Enumeration ['all', 'authentication', 'client']

   Sample Response (200 OK)

   

   {    
   "data": {        
     "status": true,        
     "message": "success"    
     },    
   "return_code": 0
   }

   

   Response Definitions

   Response Item	Description	Data Type
   return_code	A flag indicating success or failure of the operation	Boolean
   data	Data returned by the API server	String
   errors	List of errors, if any	String