Qodex.ai

getSiteCapturingStatus

GET https://{{host}}/api/v1/sites/:site_id/pcaps/capture

Response Parameters

NameTypeDescription
typestringpacket capture type, for example: new_assoc, client, wired, wireless, radiotap, gateway
aps[]stringList of target APs to capture packets
ok[]stringList of target APs successfully configured to capture packets
failed[]stringList of APs where configuration attempt failed
gatewaysdictInformation on gateways to capture packets on if a gateway capture type is specified
switchesdictInformation on switches to capture packets on if a switch capture type is specified. irb port interface is automatically added to capture as needed to ensure all desired packets are captured.
idstringunique id for the capture
max_num_packetsintmax number of packets configured by user
num_packetsinttotal number of packets captured by all AP, not applicable for type [client, new_assoc]
tcpdump_expressionstringtcpdump expression provided by the user (common)
wired_tcpdump_expressionstringwiredtcpdumpexpression provided by the user when type = ‘wired’
radiotap_tcpdump_expressionstringradiotaptcpdumpexpression expression provided by the user when type = ‘rdiotap’
scan_tcpdump_expressionstringscantcpdumpexpression provided by the user when type = ‘scan’
wireless_tcpdump_expressionstringwirelesstcpdumpexpression provided by the user when type = ‘wireless’
pcap_apsdictcontains AP specific configuration selected by user during scan pcap.

RESPONSES

status: OK

{"type":"radiotap","max_pkt_len":128,"includes_mcast":false,"ssid":null,"ap_mac":null,"client_mac":"60a10a773412","max_num_packets":1000,"num_packets":999,"duration":300,"id":"87093aed-94d6-4310-83a9-d7248c9e2d93","tcpdump_expression":"vlan and icmp","started_time":1435080709,"aps":["5c5b350e001c","5c5b350e001b"],"ok":["5c5b350e001c","5c5b350e001b"],"failed":[],"pcap_aps":{"5c5b35000010":{"band":"6","bandwidth":"20","channel":133,"tcpdump_expression":null}}}