Extreme Networks HIQ 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 HIQ. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
11 operations
across 7 paths,
and defines 9 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.
11 operations7 paths9 schemas1 DELETE5 GET2 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Extreme Networks HIQ API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
BearerAuth — JSON Web Token (JWT) based authentication
Paths & Operations 11
Across 7 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
HIQ 11
Hierarchical ExtremeCloud IQ
GET
/hiq/status
Get HIQ status
getHiqStatus→ 200default
GET
/hiq/context
Get HIQ context
getHiqContext→ 200default
PUT
/hiq/context
Set HIQ context
setHiqContextbody→ 200default
GET
/hiq/context/reading
Get organizations for reading data
getReadingOrgIds→ 200default
PUT
/hiq/context/reading
Set organizations for reading data
setReadingOrgIdsbody→ 200default
GET
/hiq/context/creating
Get organization for creating new data
getCreatingOrgId→ 200default
PUT
/hiq/context/creating
Set organization for creating new data
setCreatingOrgIdbody→ 200default
GET
/hiq/organizations
List all organizations
listOrganizations→ 200default
POST
/hiq/organizations
Create a new organization
createOrganizationbody→ 201default
DELETE
/hiq/organizations/{id}
Delete an existing organization
deleteOrganization1 param→ 204default
POST
/hiq/organizations/{id}/:rename
Rename an existing organization
renameOrganization1 parambody→ 204default
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are XiqError (6 properties), XiqBaseEntity (3 properties), XiqCreateOrganizationRequest (2 properties), XiqHiqContext (2 properties). Each schema is shown below with its type and property counts.
XiqViqEntity
XiqError
object
6 properties3 required
XiqHiqContext
object
2 properties2 required
XiqErrorParams
object
Error parameters
2 properties
XiqHiqStatus
object
1 property1 required
XiqOrganization
XiqCreateOrganizationRequest
object
2 properties1 required
XiqOrganizationType
string
The organization type
XiqBaseEntity
object
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
