How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Networks Utilities PCAPs API

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

Juniper Networks Utilities PCAPs API is one of 263 APIs that Juniper Networks 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, an API reference, API documentation, a getting-started guide, and rate-limit docs.

This API exposes 9 operations across 5 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 2607.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 48 schemas 2 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2607.1.1
Base URL
netconf://[device-ip]:830
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Juniper Networks Utilities PCAPs API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a csrftoken cookie.…

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 48

The contract defines 48 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_gateway_gateways
object
Gateway-specific packet capture settings keyed under a gateway MAC address
1 property
capture_switch_ports_tcpdump_expression
object
Per-port tcpdump filter for a switch packet capture
1 property
pcap_type1
string
Packet capture type for the current session. enum: client, gateway, newassoc, radiotap, radiotap,wired, wired, wireless.
response_pcap_status_mxedges_item
object
Mist Edge interface settings for a packet capture
1 property
capture_radiotap_format2
string
Output format for the radiotap packet capture. enum: pcap, stream.
capture_gateway_format2
string
Output format for the gateway packet capture. enum: stream.
capture_wired
object
Initiate a Wired Packet Capture
7 properties 1 required
capture_new_assoc
object
Initiate a packet Capture for New Wireless Client Associations
8 properties 1 required
capture_radiotapwired_band2
string
Radio band to capture for the radiotap portion. enum: 24, 24,5,6, 5, 6.
response_pcap_search_item
object
Packet capture record returned by organization or site packet capture search
16 properties 3 required
capture_scan_format2
string
Output format for the scan radio packet capture. enum: pcap, stream.
capture_switch
object
Initiate a Switch (Junos) Packet Capture
8 properties 2 required
capture_gateway
object
Initiate a Gateway (SSR/SRX) Packet Capture
7 properties 2 required
dot11_bandwidth1
integer
Channel bandwidth to use for the scan radio packet capture. enum: 0, 20, 40, 80, 160.
capture_radiotapwired_format2
string
Output format for the combined packet capture. enum: pcap, stream.
capture_radiotap
object
Initiate a Radiotap Packet Capture
11 properties 1 required
response_pcap_start
object
Packet capture session created by a start request
18 properties 5 required
response_http404
object
Standard HTTP 404 not found error response
1 property
response_pcap_search
object
Paginated response for packet capture search results
6 properties 4 required
capture_radiotapwired
object
Initiate a Radiotap Packet Capture and Wired Packet Capture
14 properties 1 required
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
response_http403
object
Standard HTTP 403 permission error response
1 property
notes_string
object
Request body containing notes text
1 property
capture_client
object
Initiate a Client Packet Capture
8 properties 1 required
response_http400
object
Standard HTTP 400 bad request error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
response_pcap_search_item_pcap_aps_item
object
AP radio settings captured for a packet capture record
4 properties
response_pcap_status
object
Current status of a packet capture session
34 properties 2 required
capture_mxedge_mxedges
object
Property key is the Mx Edge ID, currently limited to one mxedge per org capture session
1 property
capture_org
Packet capture request payload for organization-level captures
capture_wireless
object
Initiate a Wireless Packet Capture
9 properties 1 required
capture_wireless_format2
string
Output format for the wireless packet capture. enum: pcap, stream.
capture_mxedge_format3
string
Output format for the Mist Edge packet capture. enum: stream, tzsp.
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_site
Packet capture request payload for site-level captures
capture_radiotap_band2
string
Radio band to capture for radiotap packets. enum: 24, 24,5,6, 5, 6.
capture_scan_aps_band2
string
Radio band on which to start the scan capture. enum: 24, 5, 6.
capture_scan
object
Initiate a Scan Radio Packet Capture
13 properties 1 required
capture_scan_band2
string
Radio band to capture for scan radio packets. enum: 24, 5, 6.
response_http401
object
Standard HTTP 401 authentication error response
1 property
capture_switch_format2
string
Output format for the switch packet capture. enum: stream.
capture_gateway_gateways_port
object
Per-port tcpdump filter for a gateway packet capture
1 property
capture_switch_switches
object
Switch-specific packet capture settings keyed under a switch MAC address
1 property
capture_wireless_band2
string
Radio band to capture for wireless packets. enum: 24, 5, 6.
response_pcap_ap
object
AP radio settings used for a packet capture
4 properties
capture_mxedge
object
Initiate a Mist Edge Packet Capture
9 properties 1 required
capture_wired_format2
string
Output format for the wired packet capture. enum: pcap, stream.
capture_mxedge_format2
string
Output format for packet capture data. enum: stream, tzsp.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-utilities-pcaps-api-openapi.yml Raw ↑

Other APIs Juniper Networks publishes across the network.

Junos PyEZ (Python API)
JSNAPy API
Juniper Networks Allowlists and Blocklists API
Juniper Networks Analytics API
Juniper Networks Audit Logs API
Juniper Networks Authentication API
Juniper Networks BGP Routers API
Juniper Networks Blueprints API
Juniper Networks Clients API
Juniper Networks Configlets API
Juniper Networks Configuration API
Juniper Networks Connectivity Templates API
Where this information came from

This is an independent, third-party profile of Juniper Networks Utilities PCAPs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.