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

The clients associate to the devices of ExtremeCloud IQ

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

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

9 operations 9 paths 16 schemas 1 DELETE6 GET1 POST1 PUT

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

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 9

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

Client 9

The clients associate to the devices of ExtremeCloud IQ

GET
/clients/active
List active clients
getActiveClients 17 params → 200default
GET
/clients/summary
Get client summary metrics
getClientSummary 9 params → 200default
GET
/clients/usage
Get usage per client
getClientUsage 3 params → 200default
GET
/clients/{id}
Get client info
getClient 3 params → 200default
PUT
/clients/alias
Set the aliases for multiple clients
setClientsAliases body → 200default
GET
/clients/active/count
Get active clients count
getActiveClientsCount 14 params → 200default
DELETE
/clients/byMac/{clientMac}
Disconnect the client
disconnectClient 1 param → 200default
GET
/clients/getByMac/{clientMac}
Get client info by mac
getClientByMac 3 params → 200default
POST
/clients/disconnect
Disconnect clients
disconnect_clients body → 200default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are XiqError (6 properties), XiqPage (4 properties), XiqBaseEntity (3 properties), XiqClientSummary (2 properties). Each schema is shown below with its type and property counts.

PagedXiqClient
XiqLocationEntity
XiqClientField
string
XiqClient
XiqClientView
string
The logic collections of client fields BASIC: ID, ORGID, HOSTNAME, MACADDRESS, IPADDRESS, IPV6ADDRESS, OSTYPE, DEVICEID,CONNECTED, ONLINETIME, OFFLINETIME, CON…
XiqClientMacAddressAlias
object
The client's mac address and alias
2 properties 1 required
XiqErrorParams
object
Error parameters
2 properties
XiqBaseEntity
object
3 properties 3 required
XiqError
object
6 properties 3 required
XiqClientUsage
object
The client usage over the period
2 properties
GetActiveClientsResponse
object
1 property
XiqPage
object
4 properties 4 required
XiqViqEntity
XiqClientSummary
object
The summary for clients
2 properties
XiqDeviceEntity
XiqLocationLegend
object
The simple location information
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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