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

The details of client associate to the devices of ExtremeCloud IQ

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

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

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

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 2

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

Client - Details 2

The details of client associate to the devices of ExtremeCloud IQ

GET
/client-details/topology/client-trail/{macAddress}
Client Trail Topology
clientDetailsTopology 1 param → 200default
GET
/client-details/overview/info/{clientId}
Client Details Overview
clientDetailsOverview 3 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are topology_node (25 properties), client_details_overview (21 properties), topology_link (9 properties), client_details_topology (8 properties). Each schema is shown below with its type and property counts.

topology_node_poe_info
object
Poe Info of Topology Node
7 properties
XiqError
object
6 properties 3 required
topology_position
object
Position for Topology Node
2 properties
client_details_topology
object
The Topology for Client
8 properties
topology_node
object
The Topology Node
25 properties
topology_neighbor
object
Neighbor of Topology nodes
6 properties
topology_stack_member_info
object
Details of Topology Node stack vlaninfo
6 properties
XiqErrorParams
object
Error parameters
2 properties
topology_link
object
The Topology Link
9 properties
topology_unknown_device
object
Details of Unknown Device in Topology
4 properties
client_details_overview
object
The OverView for Client
21 properties
topology_node_vlan
object
Vlan Info for Topology Node
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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