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

Thread Networks in ExtremeCloud IQ

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

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

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

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 3

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

Thread 3

Thread Networks in ExtremeCloud IQ

GET
/thread/networks
Get active thread networks
getThreadNetworks 5 params → 200default
GET
/thread/topology
Get thread network topology
getThreadNetworkTopology 5 params → 200default
GET
/thread/routers
List thread routers
getThreadRouters 7 params → 200default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are XiqThreadNetworkConfig (19 properties), XiqThreadNetworkInterface (17 properties), XiqThreadNetDataPrefix (13 properties), XiqThreadBorderRouterService (10 properties). Each schema is shown below with its type and property counts.

XiqThreadBorderRouterService
object
The thread border router service
10 properties
XiqThreadNetworkTopology
object
The thread network topology
3 properties
XiqLocationEntity
XiqSortOrder
string
XiqClientField
string
XiqThreadNetworks
object
Active thread networks
1 property
XiqThreadNat64Service
object
The nat64 service on border router
3 properties
XiqThreadRouter
XiqThreadBackboneBorderRouterService
object
The thread backbone border router service
1 property
XiqClient
XiqClientView
string
The logic collections of client fields BASIC: ID, ORGID, HOSTNAME, MACADDRESS, IPADDRESS, IPV6ADDRESS, OSTYPE, DEVICEID,CONNECTED, ONLINETIME, OFFLINETIME, CON…
XiqThreadCommissionerService
object
The commissioner service
1 property
XiqErrorParams
object
Error parameters
2 properties
XiqThreadNetDataRoute
object
6 properties
XiqThreadRouterView
string
XiqBaseEntity
object
3 properties 3 required
XiqThreadRouterNeighbor
object
The Thread Router neighbors associate to ExtremeCloud IQ device
4 properties
XiqError
object
6 properties 3 required
XiqThreadBorderAgentService
object
The thread backbone agent service
2 properties
XiqThreadIpv6Setting
object
The thread client IP addresses
4 properties
XiqThreadNetDataPrefix
object
13 properties
PagedXiqThreadRouter
XiqPage
object
4 properties 4 required
XiqThreadNetDataService
object
6 properties
XiqViqEntity
XiqThreadNetworkData
object
The thread network data
5 properties
XiqThreadRouterField
string
XiqThreadNetworkConfig
object
The thread network configuration and security policy
19 properties
ThreadRouterSortField
string
All available thread router sort fields
XiqThreadMleLinkMode
object
The thread MLE Link Mode configuration
3 properties
XiqThreadLeaderService
object
The thread leader service
4 properties
XiqDeviceEntity
XiqLocationLegend
object
The simple location information
2 properties
XiqThreadNetworkInterface
object
The thread veth0 network interface
17 properties
XiqThreadVersion
object
The thread version
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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