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 Application API

Application management and application metrics

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

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

6 operations 6 paths 17 schemas 4 GET2 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 Application API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 6

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

Application 6

Application management and application metrics

GET
/applications
List the applications
listApplications 8 params → 200default
GET
/applications/top{n}
List the TopN applications
listTopApplicationsUsage 3 params → 200default
GET
/applications/{id}/clients/top{n}
List the TopN clients for a application
listApplicationTopClientsUsage 4 params → 200default
POST
/applications/grid
List application usage summary
listApplicationUsageSummary 6 params body → 200default
GET
/applications/category_metadata
List application categories and names
listApplicationCategoriesAndNames → 200default
POST
/applications/grid/export
Export application usage summary
export_application_usage_to_csv 4 params body → 202default

Schemas 17

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

XiqTopApplicationsUsage
object
The Top N Applications Usage
5 properties
XiqSortOrder
string
XiqApplicationDetectionProtocol
string
PagedXiqApplication
XiqApplicationDetectionType
string
XiqErrorParams
object
Error parameters
2 properties
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
XiqBaseEntity
object
3 properties 3 required
XiqError
object
6 properties 3 required
RmAppUsageSummary
object
6 properties
XiqPage
object
4 properties 4 required
XiqApplication
XiqViqEntity
XiqApplicationSortField
string
PagedAppUsageSummary
XiqApplicationTopClientsUsage
object
The Top N Clients Usage per Application
5 properties
XiqApplicationDetectionRule
object
The Application Detection Rule
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-application-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 Authentication API