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 Client Health API

Client dashboard

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

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

5 operations 5 paths 13 schemas 5 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 Client Health API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 5

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

Dashboard - Wired Client Health 5

Client dashboard

POST
/dashboard/wired/client-health/grid
Wired client health grid
wiredClientHealthGrid 5 params body → 200default
POST
/dashboard/wired/client-health/ip-connectivity-issues
Wired clients count with IP connectivity issues
wiredClientHealthIpConnectivityIssues 1 param body → 200default
POST
/dashboard/wired/client-health/port-congestion
Wired clients count with port congestion issues
wiredClientHealthPortCongestionIssues 1 param body → 200default
POST
/dashboard/wired/client-health/traffic-anomalies
Wired clients count with traffic anomalies
wiredClientHealthTrafficAnomalies 1 param body → 200default
POST
/dashboard/wired/client-health/port-errors
Wired clients count with port errors
wiredClientHealthPortErrors 1 param body → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are XiqWiredClientHealthGridResponse (23 properties), XiqError (6 properties), number_filter (5 properties), XiqWiredClientHealthIpConnectivityIssues (4 properties). Each schema is shown below with its type and property counts.

XiqWiredClientHealthGridResponse
object
23 properties
XiqError
object
6 properties 3 required
PagedXiqWiredClientHealthGridResponse
XiqWiredClientHealthConnectionStatus
string
XiqWiredClientHealthPortCongestionIssues
object
3 properties
XiqSortOrder
string
XiqWiredClientHealthTrafficAnomalies
object
3 properties
XiqErrorParams
object
Error parameters
2 properties
XiqPage
object
4 properties 4 required
number_filter
object
If the filter type is between, only then min and max are to be used, else value is to be used.
5 properties
XiqWiredClientHealthIpConnectivityIssues
object
4 properties
XiqWiredClientHealthPortErrors
object
3 properties
XiqWiredClientHealthSortField
string
Pre-defined filters for client health sorting - CONNECTIONSTATUS - CLIENTHOSTNAME - SITE - BUILDING - FLOOR - IPV4 - IPV6 - PORTNUMBER - PORTNUMBERSWITCHNAME -…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-dashboard-wired-client-health-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