stopOrgPacketCapture
Stop the currently running organization packet capture and end its websocket output stream.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidResponse Body
curl -X DELETE "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/pcaps/capture"startOrgPacketCapture POST
Start an organization-level packet capture for org-level Mist Edges **NOTE**: For packet captures of org level Mist Edges only. Use [Start Site Packet Capture](/api/mist/utilities/utilities-pcaps/startSitePacketCapture) for site level Mist Edges. The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ```json { "subscribe": "/orgs/:org_id/pcaps" } ``` #### Response (MxEdge) ```json { "event": "data" "channel": "/orgs/67970e46-4e12-11e6-9188-0242ac110007/pcaps" "data": { "capture_id": "f039b1b4-a23e-48b2-906a-0da40524de73", "pcap_dict": { "dst_mac": "68:ec:c5:09:2e:87", "src_mac": "8c:3b:ad:e0:47:40", "vlan": 1, "src_ip": "34.224.147.117", "dst_ip": "192.168.1.55", "dst_port": 51635, "src_port": 443, "protocol": "TCP", "mxedge_id": "00000000-0000-0000-1000-001122334455", "direction": "tx", "timestamp": 1652247615, "length": 159.0, "lost_messages": 0, "interface": "port0", "info": "1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq \n 2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\n", }, "pcap_raw": "1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==" } } ``` #### Stop Response ```json { "event": "data" "channel": "/orgs/67970e46-4e12-11e6-9188-0242ac110007/pcaps" "data": { "capture_id": "a2f7374d-6a70-41fd-8a3f-71e42573baaf", "pcap_dict": null } } ```
getSiteCapturingStatus GET
Get Capturing status