5.13.6 api pcap live stats

The api/pcap/live/stats function is used for getting of status of the chunked packet capture.

Service and Privileges Groups

  • Service group is System.

  • Privileges group is System Control.


Methods

  • GET

  • POST

Request

The request does not have any parameters.


Example of a Request

URL: https://192.168.1.1/api/pcap/live/stats

Response

The response is in the application/json format. The response contains the success and result keys. The result value contains detailed information on the packet capture status.


Table 1. Response JSON Keys
KeyTypical Returned ValuesDescription

running

true or false

Indicates whether the chunked packet capture is currently running or not.

bytesSent

Integer

Contains the number of bytes sent in the currently running open packet capture. If the packet capture is not running, the value is 0.

packetsSent

Integer

Contains the number of packets sent in the currently running open packet capture. If the packet capture is not running, the value is 0.


Example of a Response

{ "success": true, "result": { "running": true, "bytesSent": 11261, "packetsSent": 90 } }