REST API description: Difference between revisions

Line 106: Line 106:
The following parameters are possible:
The following parameters are possible:


* startTime: The start time of the capture. The first packet with exactly this or a later time will start the capture. The time format must be microseconds after January, 1st 1970 UTC (Unix time, epoch).  
* startTime: The start time of the capture. The first packet with exactly this or a later time will start the capture. The time format must be microseconds after January, 1st 1970 UTC (Unix time, epoch). If the start time is in the past, make sure you set fromCaptureBuffer parameter accordingly.
If the start time is in the past, make sure you set fromCaptureBuffer parameter accordingly.
* endTime: The end time of the capture. The first packet with exactly this or a later time will stop the capture. The time format must be microseconds after January, 1st 1970 UTC (Unix time, epoch).
 
* endTime: The end time of the capture. The first packet with exactly this or a later time will stop the capture.
 
The time format must be microseconds after January, 1st 1970 UTC (Unix time, epoch).
 
* expression: The filter expression. There are no whitespaces allowed. You may use ‘%20’ instead.
* expression: The filter expression. There are no whitespaces allowed. You may use ‘%20’ instead.
* snapPacketLength: The maximum size of a packet applied on Layer 2 without frame check sequence. If a packet is larger than this value, it is truncated. Use 65535 for unlimited size.
* snapPacketLength: The maximum size of a packet applied on Layer 2 without frame check sequence. If a packet is larger than this value, it is truncated. Use 65535 for unlimited size.
* fromCaptureBuffer: Whether to extract data from the packet ring buffer (= true) or just live traffic (= false).
* fromCaptureBuffer: Whether to extract data from the packet ring buffer (= true) or just live traffic (= false).
* captureToMedia: Whether to store a pcap on an external storage device (= true) or download to your computer (= false).
* captureToMedia: Whether to store a pcap on an external storage device (= true) or download to your computer (= false).
546

edits