Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Utilities PCAPs API

API Calls to start, stop or managed Packet Captures at the device level

Juniper Mist AI Utilities PCAPs API is one of 211 APIs that Juniper Mist AI 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 and API documentation.

This API exposes 9 operations across 5 paths, and defines 79 schemas. It is described by OpenAPI 3.1.0, at version 2604.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.

9 operations 5 paths 79 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Utilities PCAPs API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Utilities PCAPs 9

API Calls to start, stop or managed Packet Captures at the device level

GET
/api/v1/orgs/{org_id}/pcaps
listOrgPacketCaptures
listOrgPacketCaptures 6 params → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/pcaps/capture
stopOrgPacketCapture
stopOrgPacketCapture 1 param → 200400401403404429
GET
/api/v1/orgs/{org_id}/pcaps/capture
getOrgCapturingStatus
getOrgCapturingStatus 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/pcaps/capture
startOrgPacketCapture
startOrgPacketCapture 1 param body → 200400401403404429
GET
/api/v1/sites/{site_id}/pcaps
listSitePacketCaptures
listSitePacketCaptures 7 params → 200400401403404429
DELETE
/api/v1/sites/{site_id}/pcaps/capture
stopSitePacketCapture
stopSitePacketCapture 1 param → 200400401403404429
GET
/api/v1/sites/{site_id}/pcaps/capture
getSiteCapturingStatus
getSiteCapturingStatus 1 param → 200400401403404429
POST
/api/v1/sites/{site_id}/pcaps/capture
startSitePacketCapture
startSitePacketCapture 1 param body → 200400401403404429
PUT
/api/v1/sites/{site_id}/pcaps/{pcap_id}
updateSitePacketCapture
updateSitePacketCapture 2 params body → 200400401403404429

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are response_pcap_status (34 properties), response_pcap_start (18 properties), response_pcap_search_item (16 properties), capture_radiotapwired (14 properties). Each schema is shown below with its type and property counts.

capture_radiotap_type
string
enum: radiotap
response_pcap_status_gateways
array
Information on gateways to capture packets on if a gateway capture type is specified
strings
array
capture_wired_type
string
enum: wired
response_pcap_status_aps
array
List of target APs to capture packets
capture_gateway_gateways_ports
object
Property key is the port ID
pcap_type
string
enum: client, gateway, newassoc, radiotap, radiotap,wired, wired, wireless
response_pcap_search
object
6 properties 4 required
timestamp
number
Epoch (seconds)
capture_tcpdump_expression
stringnull
tcpdump expression
response_pcap_search_item_pcap_aps
object
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_switch_format
string
enum: stream
capture_mxedge_type
string
enum: mxedge
capture_wireless
object
Initiate a Wireless Packet Capture
9 properties 1 required
response_pcap_search_item_pcap_aps_item
object
4 properties
capture_mxedge
object
Initiate a Mist Edge Packet Capture
9 properties 1 required
response_http401
object
1 property
capture_max_pkt_length
integernull
capture_radiotapwired_band
string
only used for radiotap. enum: 24, 24,5,6, 5, 6
capture_scan_format
string
enum: pcap, stream
capture_duration
integernull
Duration of the capture, in seconds
capture_switch_type
string
enum: switch
capture_new_assoc
object
Initiate a packet Capture for New Wireless Client Associations
8 properties 1 required
capture_radiotapwired
object
Initiate a Radiotap Packet Capture and Wired Packet Capture
14 properties 1 required
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_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)
response_pcap_status_failed
array
List of APs where configuration attempt failed
response_pcap_status_mxedges_item
object
1 property
capture_site
response_pcap_search_item_aps
array
notes_string
object
1 property
capture_org
response_pcap_search_item_ap
string
response_pcap_ap
object
4 properties
response_pcap_status_pcap_aps
object
capture_scan_type
string
enum: scan
capture_radiotap_band
string
enum: 24, 24,5,6, 5, 6
capture_scan_aps_band
string
Only Single value allowed. enum: 24, 5, 6
response_pcap_start
object
18 properties 5 required
capture_radiotapwired_format
string
enum: pcap, stream
capture_num_packets
integernull
number of packets to capture, 0 for unlimited, default is 1024, maximum is 10000
capture_gateway_type
string
enum: gateway
capture_wireless_band
string
enum: 24, 5, 6
capture_mxedge_mxedges
object
Property key is the Mx Edge ID, currently limited to one mxedge per org capture session
1 property
capture_new_assoc_type
string
enum: newassoc
capture_radiotapwired_type
string
enum: radiotap,wired
response_http429
object
1 property
capture_switch_ports_tcpdump_expression
object
1 property
capture_gateway_gateways_port
object
1 property
response_pcap_status_mxedges
object
Dict of Mist Edges to capture on, property key is the Mist Edge ID
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_client
object
Initiate a Client Packet Capture
8 properties 1 required
capture_radiotap
object
Initiate a Radiotap Packet Capture
11 properties 1 required
capture_wired
object
Initiate a Wired Packet Capture
7 properties 1 required
org_id
string
capture_wired_format
string
pcap format. enum: pcap, stream
capture_radiotap_format
string
enum: pcap, stream
id
string
Unique ID of the object instance in the Mist Organization
capture_switch
object
Initiate a Switch (Junos) Packet Capture
8 properties 2 required
capture_switch_switches
object
1 property
response_http403
object
1 property
capture_client_type
string
enum: client
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
capture_gateway
object
Initiate a Gateway (SSR/SRX) Packet Capture
7 properties 2 required
site_id
string
response_http404
object
1 property
response_pcap_search_item
object
16 properties 3 required
capture_scan_band
stringnull
Only Single value allowed, default value gets applied when user provides wrong values. enum: 24, 5, 6
response_http400
object
1 property
capture_wireless_type
string
enum: wireless
response_pcap_search_results
array
response_pcap_status_ok
array
List of target APs successfully configured to capture packets
capture_gateway_format
string
enum: stream
response_pcap_status
object
34 properties 2 required
capture_scan
object
Initiate a Scan Radio Packet Capture
13 properties 1 required
capture_gateway_gateways
object
1 property
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_wireless_format
string
pcap format. enum: pcap, stream

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-utilities-pcaps-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API