REST API description: Difference between revisions

Line 102: Line 102:
<code>curl -k -u USER:PASSWORD 'https://allegro-mm-XXXX/API/data/modules/capture?expression=IP==10.1.2.3:62887 and IP==10.1.2.100:548 and l4Protocol==TCP' > path_to/capture.pcap</code>
<code>curl -k -u USER:PASSWORD 'https://allegro-mm-XXXX/API/data/modules/capture?expression=IP==10.1.2.3:62887 and IP==10.1.2.100:548 and l4Protocol==TCP' > path_to/capture.pcap</code>


==== PCAP parameters ====
==== Pcap parameters ====


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).  
Line 114: Line 114:


* 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 max 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 PCAP on external storage device (= true) or download your computer (= false).
* captureToMedia: Whether to store a pcap on an external storage device (= true) or download to your computer (= false).
inactive
369

edits