GetOrgMxEdgeCapturingStatus
GET https://{{host}}/api/v1/orgs/:org_id/pcaps/capture
Response Parameters
| Name | Type | Description |
|---|---|---|
max_num_packets | int | number of packets to capture |
duration | int | duration of the capture, in seconds |
max_pkt_len | int | max_len of each packet to capture |
mxedges | dict | dict of mxedges which uses mxedge_id as the key, currently limited to one mxedge per org capture session |
interfaces | dict | dict of interfaces to capture for, for given mxedge (examples: port1, kni0, lacp0, ipsec, drop, oobm), currently limited to specifying one interface per mxedge |
tcpdump_expression | string | tcpdump expression, interface specific if specified under interfaces dict, otherwise applicable across interfaces if specified at top level of payload. Interface specific value overrides top level value when both exist. |
format | string | pcap format: stream (the only supported option) |
RESPONSES
status: OK
{"timestamp":1695837460.309526,"id":"c5bd6c89-fa52-486f-9fd0-801cfc613328","org_id":"78c11da8-f984-4425-bedb-a7ddd7d0f6da","site_id":null,"type":"mxedge","max_num_packets":1024,"max_pkt_len":512,"duration":600,"enabled":true,"expiry":1695838060.309526,"mxedge_count":1,"invalid_mxedges":{},"format":"stream","raw":true,"mxedges":{"00000000-0000-0000-1000-001122334455":{"interfaces":{"port1":{"tcpdump_expression":"udp port 67 or udp port 68"}}}}}