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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Extreme Networks

Extreme Networks PacketCaptures API

Packet capture sessions in ExtremeCloud IQ

Documentation Provider Profile APIs.io OpenAPI GitHub

Extreme Networks PacketCaptures API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PacketCaptures. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 5 paths, and defines 26 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.

Requests are made against a single base URL, https://api.extremecloudiq.com.

7 operations 5 paths 26 schemas 1 DELETE3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
Contact
Extreme Networks Support
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Extreme Networks PacketCaptures API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 7

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

PacketCaptures 7

Packet capture sessions in ExtremeCloud IQ

GET
/packetcaptures
List packet capture sessions
listPacketCaptures 6 params → 200default
POST
/packetcaptures
Create a new packet capture session
createPacketCapture body → 200default
GET
/packetcaptures/{id}
Get a packet capture session by ID
getPacketCapture 2 params → 200default
DELETE
/packetcaptures/{id}
Delete a packet capture session
deletePacketCapture 1 param → 200default
POST
/packetcaptures/{id}/:stop
Stop a packet capture session
stopPacketCapture 1 param body → 200default
POST
/packetcaptures/{id}/:upload
Upload a packet capture session's capture files
uploadPacketCaptureFiles 1 param → 200default
GET
/packetcaptures/files
Get an AP packet capture file
getPacketCaptureFile 1 param → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are XiqError (6 properties), XiqPage (4 properties), XiqCloudSharkStorage (2 properties), XiqErrorParams (2 properties). Each schema is shown below with its type and property counts.

XiqCaptureLocation
This represents the options for location packet capture.
XiqSerialNumber
object
The globally unique serial number of the device being registered. The serial number is represented as a string.
1 property
XiqCloudSharkStorage
object
The packet capture file name and URL in CloudShark.
2 properties
XiqPacketCapture
This represents the packet capture session
XiqDestinationType
string
The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUDSHARK for sending the capture files to CloudShark, in addition to XIQ cloud sto…
XiqSortOrder
string
XiqCaptureDirectionSelection
string
The capture traffic direction
XiqPacketCaptureField
string
XiqPktCaptureStatus
string
The status of the overall packet capture session or a packet capture result on an AP device's interface.
XiqCaptureResult
This represents the packet capture result on an AP's interface. A packet capture session may involve multiple APs on multiple interfaces.
XiqCaptureFilter
This represents the properties of filters used for the packet capture.
XiqWirelessFilterType
string
Pre-defined filters for wireless packet captures.
XiqErrorParams
object
Error parameters
2 properties
XiqLocationId
object
The assigned location ID, it must be FLOOR type
1 property
XiqPolicyRuleProtocolType
string
Protocol type to filter by.
XiqDeviceIds
object
The device ID list.
1 property
XiqCaptureWiredSelection
string
Wired interface to filter by.
PagedXiqPacketCapture
XiqError
object
6 properties 3 required
XiqCaptureStopRequest
object
This represents the request for stopping a packet capture session.
1 property
XiqPage
object
4 properties 4 required
XiqCaptureIdentifier
object
Identifier for AP device selections. APs can be selected using the AP serial number, a list of device numeric IDs or the location ID.
1 property 1 required
XiqWiredFilterType
string
Pre-defined filters for wired packet captures.
XiqCaptureBandSelection
string
Wireless band to filter by.
XiqCaptureRadioSelection
string
Wireless radio type to filter by.
XiqLocationLegend
object
The simple location information
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-packetcaptures-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
AE Profile APIs.io
ExtremeCloud IQ Controller Application Manager API
AE Profile APIs.io
Ansible Network Collection for Extreme EXOS
AE Profile APIs.io
Ansible Network Collection for Extreme VOSS
AE Profile APIs.io
Ansible Network Collection for Extreme SLX-OS
AE Profile APIs.io
Ansible Network Collection for Extreme NOS
AE Profile APIs.io
Ansible Network Collection for Extreme Fabric Engine
AE Profile APIs.io
Extreme Networks Account API
AE Profile APIs.io
Extreme Networks Administration API
AE Profile APIs.io
Extreme Networks AFC API
AE Profile APIs.io
Extreme Networks Alert API
AE Profile APIs.io
Extreme Networks Application API
AE Profile APIs.io
#PacketCaptures
← Back to E APIs
API Details
ID
extreme-networks:extreme-networks-packetcaptures-api
Base URL
https://api.extremecloudiq.com
Docs
https://developer.extremecloudiq.com/
Provider
Extreme Networks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network