Packet Capture

Get a packet capture session

Get packet capture session by ID.

get/packetcaptures/{id}

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/packetcaptures/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The packet capture ID

Query parameters

fieldsXiqPacketCaptureField[]

The packet capture fields to return

Response

OK

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'
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'
status'INITIAL' | 'ACTIVE' | 'SUCCESS' | 'PARTIAL_SUCCESS' | 'FAILED'
cloud_storagestring

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

Changes

No operation changes recorded.