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

ExtremeCloud IQ Account

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

This API exposes 20 operations across 19 paths, and defines 27 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.

20 operations 19 paths 27 schemas 1 DELETE10 GET6 POST3 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 Account API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 20

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

Account 20

ExtremeCloud IQ Account

GET
/account/home
Get home ExtremeCloud IQ account info
getHomeAccount → 200default
GET
/account/external
List accessible external guest accounts
listExternalAccounts → 200default
POST
/account/:switch
Switch to another ExtremeCloud IQ account
switchAccount 1 param → 200default
GET
/account/viq
Get VIQ Info
getViqInfo → 200default
POST
/account/viq/:backup
Backup VIQ
backupViq → 200default
GET
/account/viq/default-device-password
Get the default device password in the account
getDefaultDevicePassword → 200default
PUT
/account/viq/default-device-password
Update the default device password in the account
updateDefaultDevicePassword body → 200default
PUT
/v1/account/viq/default-device-password
Update the default device password with validation
updateDefaultDevicePasswordWithValidation body → 200default
POST
/account/export
Create VIQ export data
viqExportReport 2 params → 200default
POST
/account/import
Import VIQ details from a file
viqImport 2 params body → 200default
GET
/account/download
Download VIQ reports or logs
downloadViqReports 1 param → 200default
GET
/account/export-import-status
Status of VIQ export/import operation
exportImportStatus 2 params → 200default
POST
/account/viq/:reset
Resetting VIQ
resetViq → 200default
GET
/account/vhm/setting
Get Account VHM Setting
getVhmSetting → 200default
PUT
/account/vhm/setting/{id}
Update Account VHM Setting
updateVhmSetting 1 param body → 200default
GET
/account/vhm/status
Get Account VHM Status
getVhmStatus → 200default
GET
/backup/history/grid
Get Backup History Grid
backupGrid → 200default
POST
/backup/history/:restore
Backup History Restore
backupRestore 1 param → 201default
DELETE
/backup/history/delete
Backup History Delete
backupDelete 1 param → 200default
GET
/third/party/applications
Get third party applications
getThirdPartyApplications → 200default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are XiqViqExportImportResponse (9 properties), XiqViq (7 properties), XiqBackupGrid (7 properties), XiqUpdateVhmSettingRequest (7 properties). Each schema is shown below with its type and property counts.

PagedBackupGrid
XiqVhmSettingInfo
XiqExternalAccount
XiqLicenseStatus
string
The VIQ license status
XiqAccount
XiqAccountMode
string
Account mode
XiqThirdPartyApplications
object
5 properties
XiqViqLicense
XiqVhmStatus
object
VHM Account Status
2 properties
XiqErrorParams
object
Error parameters
2 properties
XiqVhmSetting
XiqDefaultDevicePassword
object
The default device password
1 property 1 required
XiqBaseEntity
object
3 properties 3 required
XiqViqTasks
object
4 properties
XiqError
object
6 properties 3 required
XiqViqExportImportResponse
object
9 properties
XiqLicenseMode
string
The license mode
XiqPage
object
4 properties 4 required
XiqBackupGrid
object
Backup History Grid
7 properties
XiqUpdateVhmSettingRequest
object
7 properties
XiqLoginResponse
object
3 properties 3 required
XiqViqImportReport
object
ExtremeCloud IQ Viq Import data
2 properties
XiqViqStatusType
string
XiqAccountType
string
Account type
XiqViq
object
7 properties
XiqViqExportReport
object
ExtremeCloud IQ Viq Export data
3 properties
XiqEntitlementType
string
The entitlement key type

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-account-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 Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API
Extreme Networks Authentication API