HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

POST operation to start an packet capture process.

post
http://localhost:3001/rest/json/tcpdump/run

This API allows you to start a packet capture process if there isn't one running already. If there's already an packet capture running, this API will response HTTP 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Additoinal filter expression for tcpdump

boolean

Enable circular storage

integer
Defaults to 100

maximum size per file in MB for circular storage

integer
Defaults to 5

maximum number of file for circular storage

interfaces
array of objects
interfaces
string

Filter only for this IP to capture

integer
required
Defaults to 10000

Desired number of packets to capture

integer

Filter only for this port to capture

integer
Defaults to 100

Snapshot length is the amount of data for each frame that is actually captured

Response
200

No response

Updated about 1 year ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 1 year ago