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 API

Device and client health and status/dashboard

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

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

11 operations 10 paths 19 schemas 3 GET8 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 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 3 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboard 11

Device and client health and status/dashboard

POST
/dashboard/alerts
Alert statistics
alertCountDashboard 2 params body → 200default
POST
/dashboard/assets
Asset statistics
assetCountDashboard 1 param body → 200default
POST
/dashboard/clients
Client health statistics
clientHealthDashboard 1 param body → 200default
POST
/dashboard/devices
Device health statistics
deviceHealthDashboard 1 param body → 200default
POST
/dashboard/usage-capacity
Usage & capacity statistics
usageAndCapacityIssuesDashboard 1 param body → 200default
POST
/dashboard/sites-with-issues
Sites with issues
sitesWithIssuesDashboard 7 params body → 200default
GET
/dashboard/device_types
Dashboard device types
dashboardDeviceTypes → 200default
POST
/dashboard/export
Export Sites with issues as CSV File
sitesWithIssuesDashboardExport 5 params body → 202default
GET
/dashboard/wireless/dashboard/criteria
Criteria for Wireless Diagnostics Dashboard
wirelessDiagnosticsDashboardCriteria → 200default
POST
/dashboard/wireless/dashboard/criteria
Create Criteria for Wireless Diagnostics Dashboard
createWirelessDiagnosticsDashboardCriteria body → 200default
GET
/dashboard/wireless/dashboard/reports/{id}
Download the Export CSV file
siteWithIssueGridExportReport 1 param → 200default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are XiqWirelessUsageAndCapacityCriteria (42 properties), XiqWirelessClientHealthCriteria (24 properties), XiqPostWirelessClientHealthCriteria (14 properties), XiqWirelessDeviceHealthCriteria (12 properties). Each schema is shown below with its type and property counts.

XiqClientHealthResponse
object
4 properties
XiqSortOrder
string
XiqAssetsResponse
object
4 properties
XiqSiteWithIssuesSortField
string
Pre-defined sort fields for Site with issues
XiqSitesWithIssuesResponse
object
8 properties
XiqUsageAndCapacityResponse
object
3 properties
XiqRmDiagnosticsDeviceType
string
The type of RM diagnostic device
XiqWirelessUsageAndCapacityCriteria
object
42 properties
PagedXiqSitesWithIssuesResponse
XiqErrorParams
object
Error parameters
2 properties
XiqPostWirelessClientHealthCriteria
object
14 properties
XiqWirelessDeviceHealthCriteria
object
12 properties
XiqError
object
6 properties 3 required
XiqPage
object
4 properties 4 required
XiqPostWirelessDeviceHealthCriteria
object
5 properties
XiqWirelessClientHealthCriteria
object
24 properties
XiqPostWirelessUsageAndCapacityCriteria
object
7 properties
XiqDeviceHealthResponse
object
4 properties
XiqAlertsResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-dashboard-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