v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB

Packet Capture

Get a packet capture session

Get packet capture session by ID.

get/packetcaptures/{id}

Path parameters

idinteger required

The packet capture ID

Query parameters

fieldsXiqPacketCaptureField[]

The packet capture fields to return

Response

idinteger

The unique identifier

start_timestring date-time

The packet capture start time

end_timestring date-time

The packet capture end time

org_idinteger

The organization identifier, valid when enabling HIQ feature

namestring

The packet capture session name. If the name is null or empty, it will be auto generated.

durationinteger

An integer containing the set packet capture duration in seconds, from 5 to a maximum of 604800 seconds (1 week). If duration is set to 0 or unspecified, capture stops when platform-maximum size is reached.

capture_id_type'AP_SERIAL_NUMBER' | 'DEVICE_IDS' | 'LOCATION'

The capture identifier type for selecting the APs. Depending on the type, one of "ap_serial_number", "device_ids" and "location_id" must be provided.

ap_serial_numberstring

The globally unique serial number of the device being registered. The serial number is represented as a string.

device_idsinteger[]

The device ID list.

location_idinteger

The assigned location ID, it must be FLOOR type

destination'CLOUD' | 'CLOUD_SHARK'

The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage.

status'INITIAL' | 'ACTIVE' | 'SUCCESS' | 'PARTIAL_SUCCESS' | 'FAILED'

The status of the packet capture result

cloud_storagestring

XIQ cloud storage location for the archive of all capture files in this capture session, if available.