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 Network Scorecard API

The network scorecard containing device, client, network, Wi-Fi, services health of the selected location.

Extreme Networks Network Scorecard 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 Network Scorecard. 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 7 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 7 schemas 5 GET

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 Network Scorecard 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 GET. Each is listed below with its method, path, parameters, and response codes.

Network Scorecard 5

The network scorecard containing device, client, network, Wi-Fi, services health of the selected location.

GET
/network-scorecard/locations/{id}/device-health
Get device's overall health for given location
getDeviceHealth 3 params → 200default
GET
/network-scorecard/locations/{id}/client-health
Get clients' overall health for given location
getClientHealth 6 params → 200default
GET
/network-scorecard/locations/{id}/wifi-health
Get devices' Wi-Fi health for given location
getWifiHealth 3 params → 200default
GET
/network-scorecard/locations/{id}/network-health
Get devices' network health for given location
getNetworkHealth 3 params → 200default
GET
/network-scorecard/locations/{id}/services-health
Get devices' services health for given location
getServicesHealth 3 params → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are XiqError (6 properties), WiFiOverallHealth (4 properties), DeviceOverallHealth (4 properties), ClientOverallHealth (4 properties). Each schema is shown below with its type and property counts.

XiqError
object
6 properties 3 required
ServicesOverallHealth
object
The network health score over the period
4 properties
NetworkOverallHealth
object
The network health score over the period
4 properties
ClientOverallHealth
object
The clients health score over the period
4 properties
DeviceOverallHealth
object
The devices health score over the period
4 properties
WiFiOverallHealth
object
The clients health score over the period
4 properties
XiqErrorParams
object
Error parameters
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-network-scorecard-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