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

Extreme Networks Dashboard - Wired Usage and Capacity API

Wired Usage and Capacity

Extreme Networks Dashboard - Wired Usage and Capacity 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 Dashboard - Wired Usage and Capacity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 11 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.

4 operations 4 paths 11 schemas 4 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
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Extreme Networks Dashboard - Wired Usage and Capacity API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboard - Wired Usage and Capacity 4

Wired Usage and Capacity

POST
/dashboard/wired/usage-capacity/grid
Wired Usage and Capacity grid
wiredUsageCapacityGrid 5 params body → 200default
POST
/dashboard/wired/usage-capacity/usage-utilization
Wired devices total utilized bandwidth
wiredUsageCapacityUsageUtilization body → 200default
POST
/dashboard/wired/usage-capacity/wired-throughput
Wired devices throughput
wiredUsageCapacityThroughput body → 200default
POST
/dashboard/wired/usage-capacity/wired-congestion
Wired devices congestion
wiredUsageCapacityCongestion body → 200default

Schemas 11

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

PagedXiqWiredUsageCapacityGridResponse
XiqWiredUsageCapacityUsageUtilization
object
1 property
XiqError
object
6 properties 3 required
XiqWiredUsageCapacityFilter
The filters available for usage and capacity grid
XiqWiredUsageCapacityCongestion
object
3 properties
XiqWiredUsageCapacityGridResponse
object
18 properties
XiqSortOrder
string
XiqErrorParams
object
Error parameters
2 properties
XiqPage
object
4 properties 4 required
XiqWiredUsageCapacitySortField
string
Pre-defined fields for usage and capacity sorting - DEVICEHOSTNAME - DEVICEIP - SITE - TOTALCLIENTSCOUNT - TOTALISSUECLIENTSCOUNT - TOTALBANDWIDTHUTILIZED - TO…
XiqWiredUsageCapacityThroughput
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-dashboard-wired-usage-and-capacity-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API