Get APTest Schedule

To retrieve all configured access point test schedules:
  1. Log in to the REST API server using administrator credentials. You must also forward the session ID variable with each API call.
  2. Use the GET method to access the tools/get-aptest-schedules endpoint and fetch the access point test schedule.

    Sample Request

    curl -X GET --cookie auth_token=$cookie http://134.141.242.93/nsight-ui/api
    /v1/tools/get-aptest-schedules?treeSelection=%2FSystem
    Click to expand in new window

    Query String Parameters

    Parameter Required/Optional Description Data Type
    treeSelection Required The type of access point entries to be returned in the response. Possible values are:
    • /System: Returns access point schedules across all sites.
    • /System/<site>: Returns access point schedule for a specific site.
    String

    Sample Response (200 OK)

    {
    "data":[{     
    		"_id": "5bc873430825060de16e1092",            
    		"active": true,            
    		"ap_count": 1,            
    		"apid": [                
    		{                    
    			"apid": "74-67-F7-5C-21-F1",                    
    			"apname": "ap8533-5C21F1",                    
    			"next_t": 1540080000000,                    
    			"rfd": "test",                    
    			"rfmode": "2.4GHz-wlan",                    
    			"ridx": 1,                    
    			"state": 1,                    
    			"status": 1,                    
    			"widx": 1                
    		}],            
    		"apidlist":[              
    			"74-67-F7-5C-21-F1"            
    		],            
    		"apname": "ap8533-5C21F1",            
    		"authentication": 1,            
    		"clientid": "",            
    		"dnsTest":{                
    			"dnsName": "",                
    			"nameLength": "",                
    			"options": "",                
    			"selected": false,                
    			"testCount": ""            
    		},            
    		"eap_params":{                
    			"fast_pac_certificate": "",                
    			"method": "",                
    			"outer_identity": "",
    			"password": "",                
    			"server_certificate": "",                
    			"server_certificate_required": "",                
    			"user_certificate": "",                
    			"username": ""            
    		},            
    		"enable": "enable",            
    		"encryption": 5,            
    		"ipconfig":{                
    			"dnssettings": 0,                
    			"domainName": "0.0.0.0",                
    			"domainNameLength": 7,                
    			"gateway": "0.0.0.0",                
    			"ipaddr": "0.0.0.0",                
    			"ipsettings": 0,                
    			"netmask": "0.0.0.0",                
    			"priDnsSrv": "0.0.0.0",                
    			"reserved": "",                
    			"secDnsSrv": "0.0.0.0"            
    		},            
    		"keyMgmtType": "",            
    		"keySize": "",           
    		"l2retry":{                
    			"l2RetryCount": ""            
    		},            
    		"multicastEncType": 0,            
    		"next_t": 1540080000000,            
    		"ping": {                
    			"addr": "192.168.200.1",                
    			"count": 5,                
    			"selected": true,                
    			"size": 64,                
    			"timeout": 1000            
    		},            
    		"portscanTest":{                
    			"addr": "",                
    			"addressLength": "",                
    			"options": "",                
    			"port": "",                
    			"selected": false,                
    			"testCount": ""            
    		},            
    		"profiles": "ping",            
    		"psk_key": "",            
    		"rfd":[           
    			"test"            
    		],            
    		"rfmode": "2.4GHz-wlan",            
    		"ridx": "",            
    		"schedule":{                
    			"dayofmonth": "",
    			"dayofweek": "",                
    			"enddate": "2018-10-21",                
    			"recurrence": "Daily",                
    			"startdate": "2018-10-21",                
    			"time": "00:00"            
    		},            
    		"schedulename": "test1",            
    		"sec_info": "",            
    		"ssid": "nav-wpa",            
    		"status": 1,            
    		"thruputTest":{                
    			"addr": "192.168.200.48",                
    			"addressLength": 14,                
    			"bwThreshold": 1,                
    			"bwThresholdUnit": "kbps",                
    			"filesize": 1,                
    			"filesizeUnit": "MB",                
    			"path": "test.txt",                
    			"pathLength": 8,                
    			"port": 21,                
    			"pwd": "test1",                
    			"pwdLength": 5,                
    			"selected": true,                
    			"testDirection": 2,                
    			"timeOut": 30,                
    			"username": "user1",                
    			"usernameLength": 5,                
    			"xferType": 1            
    		},            
    		"tracerTest":{                
    			"addr": "192.168.200.1",                
    			"addressLength": 13,                
    			"options": 0,                
    			"selected": true,                
    			"tgtTestCount": 1            
    		},            
    		"treeSelection": "/System",            
    		"ts": "",            
    		"unicastEncType": 0,            
    		"user": "admin",            
    		"wep_params":{                
    			"keyIndex": "",                
    			"keyLength": "",                
    			"keyUnit": "",                
    			"keyValue": ""            
    		},            
    		"widx": "",            
    		"wlan": "nav-wpa",            
    		"wpa_protocol": null        
    	}],
    
    "return_code":0,
    "success":true,
    }