How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extreme Networks HIQ API

Hierarchical ExtremeCloud IQ

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.2.0, at version 25.9.0-36.

Requests are made against a single base URL, https://api.extremecloudiq.com.

11 operations 7 paths 9 schemas 1 DELETE5 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 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
setHiqContext body → 200default
GET
/hiq/context/reading
Get organizations for reading data
getReadingOrgIds → 200default
PUT
/hiq/context/reading
Set organizations for reading data
setReadingOrgIds body → 200default
GET
/hiq/context/creating
Get organization for creating new data
getCreatingOrgId → 200default
PUT
/hiq/context/creating
Set organization for creating new data
setCreatingOrgId body → 200default
GET
/hiq/organizations
List all organizations
listOrganizations → 200default
POST
/hiq/organizations
Create a new organization
createOrganization body → 201default
DELETE
/hiq/organizations/{id}
Delete an existing organization
deleteOrganization 1 param → 204default
POST
/hiq/organizations/{id}/:rename
Rename an existing organization
renameOrganization 1 param body → 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), XiqHiqContext (2 properties), XiqCreateOrganizationRequest (2 properties). Each schema is shown below with its type and property counts.

XiqBaseEntity
object
3 properties 3 required
XiqOrganizationType
string
The organization type
XiqCreateOrganizationRequest
object
2 properties 1 required
XiqError
object
6 properties 3 required
XiqHiqStatus
object
1 property 1 required
XiqHiqContext
object
2 properties 2 required
XiqOrganization
XiqViqEntity
XiqErrorParams
object
Error parameters
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-hiq-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
Where this information came from

This is an independent, third-party profile of Extreme Networks HIQ API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.