Mist Utilities PCAPs API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Utilities PCAPs. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
9 operations
across 5 paths,
and defines 79 schemas.
It is described by OpenAPI 3.2.0, at version 2606.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
The identity and technical contract details declared by the specification.
response_pcap_search
object
Paginated response for packet capture search results
6 properties
4 required
capture_wired_format
string
pcap format. enum: pcap, stream
capture_gateway
object
Initiate a Gateway (SSR/SRX) Packet Capture
7 properties
2 required
org_id
string
Unique identifier of a Mist organization
capture_radiotap_band
string
enum: 24, 24,5,6, 5, 6
strings
array
Unique string values returned or accepted by this schema
capture_radiotapwired_band
string
only used for radiotap. enum: 24, 24,5,6, 5, 6
capture_switch_ports
object
Property key is the port name. 6 ports max per switch supported, or 5 max with irb port auto-included into capture request
response_pcap_start
object
Packet capture session created by a start request
18 properties
5 required
capture_mxedge_format
string
PCAP format. enum: stream: to Mist cloud tzsp: stream packets (over UDP as TZSP packets) to a remote host (typically running Wireshark)
notes_string
object
Request body containing notes text
1 property
capture_tcpdump_expression
stringnull
tcpdump filter expression applied to packet capture traffic
capture_scan_format
string
Output format for the scan radio packet capture. enum: pcap, stream
capture_mxedge_mxedges_interfaces
object
Property key is the Port name (e.g. "port1", "kni0", "lacp0", "ipsec", "drop", "oobm"), currently limited to specifying one interface per mxedge
1 property
capture_switch_format
string
Output format for the switch packet capture. enum: stream
capture_gateway_gateways_ports
object
Property key is the port ID
response_http403
object
Standard HTTP 403 permission error response
1 property
capture_new_assoc_type
string
Packet capture type discriminator for new association captures. enum: newassoc
response_pcap_search_item
object
Packet capture record returned by organization or site packet capture search
16 properties
3 required
response_pcap_status_aps
array
List of target APs to capture packets
capture_switch_switches
object
Switch-specific packet capture settings keyed under a switch MAC address
1 property
capture_mxedge_type
string
Packet capture type discriminator for Mist Edge captures. enum: mxedge
pcap_type
string
enum: client, gateway, newassoc, radiotap, radiotap,wired, wired, wireless
capture_wireless
object
Initiate a Wireless Packet Capture
9 properties
1 required
response_pcap_search_item_ap
string
AP MAC address included in a packet capture
capture_mxedge
object
Initiate a Mist Edge Packet Capture
9 properties
1 required
response_pcap_status_mxedges_item
object
Mist Edge interface settings for a packet capture
1 property
response_pcap_status_ok
array
List of target APs successfully configured to capture packets
capture_radiotap_type
string
Packet capture type discriminator for radiotap captures. enum: radiotap
capture_scan_aps_band
string
Only Single value allowed. enum: 24, 5, 6
capture_wired_type
string
Packet capture type discriminator for wired captures. enum: wired
response_pcap_search_results
array
Packet capture records returned by search
response_pcap_ap
object
AP radio settings used for a packet capture
4 properties
capture_gateway_gateways
object
Gateway-specific packet capture settings keyed under a gateway MAC address
1 property
response_pcap_search_item_pcap_aps_item
object
AP radio settings captured for a packet capture record
4 properties
response_pcap_status_gateways
array
Information on gateways to capture packets on if a gateway capture type is specified
timestamp
number
Epoch timestamp, in seconds
response_pcap_status_switches
array
Information on switches to capture packets on if a switch capture type is specified. irb port interface is automatically added to capture as needed to ensure a…
capture_scan_aps
object
Property key is the AP MAC address (e.g. "5c5b35000001"). All optionals, parent parameters will be used if not defined
4 properties
capture_wireless_type
string
Packet capture type discriminator for wireless captures. enum: wireless
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
id
string
Unique ID of the object instance in the Mist Organization
dot11_bandwidth
integer
channel width for the band.enum: 0(disabled, response only), 20, 40, 80 (only applicable for band5 and band6), 160 (only for band6)
capture_max_pkt_length
integernull
Maximum bytes captured from each packet, or null to use the default
capture_gateway_gateways_port
object
Per-port tcpdump filter for a gateway packet capture
1 property
capture_radiotapwired_type
string
Packet capture type discriminator for combined radiotap and wired captures. enum: radiotap,wired
response_pcap_search_item_aps
array
AP MAC addresses included in a packet capture
response_pcap_status_pcap_aps
object
Per-AP radio capture settings keyed by AP MAC address
capture_gateway_type
string
Packet capture type discriminator for gateway captures. enum: gateway
capture_org
Packet capture request payload for organization-level captures
capture_scan_band
stringnull
Only Single value allowed, default value gets applied when user provides wrong values. enum: 24, 5, 6
response_pcap_search_item_pcap_aps
object
Per-AP radio capture settings keyed by AP MAC address
capture_wireless_format
string
pcap format. enum: pcap, stream
capture_gateway_format
string
Output format for the gateway packet capture. enum: stream
capture_wireless_band
string
enum: 24, 5, 6
response_http400
object
Standard HTTP 400 bad request error response
1 property
capture_site
Packet capture request payload for site-level captures
capture_duration
integernull
Duration of the capture, in seconds
capture_switch_type
string
Packet capture type discriminator for switch captures. enum: switch
capture_radiotap_format
string
Output format for the radiotap packet capture. enum: pcap, stream
capture_scan_type
string
Packet capture type discriminator for scan radio captures. enum: scan
capture_mxedge_mxedges
object
Property key is the Mx Edge ID, currently limited to one mxedge per org capture session
1 property
capture_client_type
string
Packet capture type discriminator for client captures. enum: client
capture_switch_ports_tcpdump_expression
object
Per-port tcpdump filter for a switch packet capture
1 property
capture_new_assoc
object
Initiate a packet Capture for New Wireless Client Associations
8 properties
1 required
capture_scan
object
Initiate a Scan Radio Packet Capture
13 properties
1 required
capture_radiotapwired_format
string
Output format for the combined packet capture. enum: pcap, stream
response_http404
object
Standard HTTP 404 not found error response
1 property
capture_wired
object
Initiate a Wired Packet Capture
7 properties
1 required
response_pcap_status
object
Current status of a packet capture session
34 properties
2 required
capture_radiotapwired
object
Initiate a Radiotap Packet Capture and Wired Packet Capture
14 properties
1 required
site_id
string
Unique identifier of a Mist site
capture_client
object
Initiate a Client Packet Capture
8 properties
1 required
response_pcap_status_mxedges
object
Dict of Mist Edges to capture on, property key is the Mist Edge ID
capture_radiotap
object
Initiate a Radiotap Packet Capture
11 properties
1 required
capture_num_packets
integernull
number of packets to capture, 0 for unlimited, default is 1024, maximum is 10000
capture_switch
object
Initiate a Switch (Junos) Packet Capture
8 properties
2 required
response_pcap_status_failed
array
List of APs where configuration attempt failed
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mist publishes across the network.
