Extreme Networks Device API
Supported device platforms: Cloud Engine, IQ Engine, WiNG, VOSS, EXOS...
Extreme Networks Device 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 Device. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 73 operations across 63 paths, and defines 134 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.
73 operations
63 paths
134 schemas
5 DELETE22 GET37 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Extreme Networks Device API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
BearerAuth— JSON Web Token (JWT) based authentication
Paths & Operations 73
Across 63 paths, the API surfaces 73 operations — 5 DELETE, 22 GET, 37 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
Device 73
Supported device platforms: Cloud Engine, IQ Engine, WiNG, VOSS, EXOS...
GET
/devices
[LRO] List devices
POST
/devices/:onboard
Onboard Devices
POST
/devices/:advanced-onboard
[LRO] Advanced Onboard Devices
POST
/devices/:manage
Change status to Managed
POST
/devices/:unmanage
Change status to Unmanaged
POST
/devices/:cli
[LRO] Send CLI to devices
POST
/devices/:reboot
Reboot devices
POST
/devices/:delete
Delete devices
POST
/devices/:reset
[LRO] Reset devices to factory default
POST
/devices/location/:query
Query location for multiple devices
POST
/devices/location/:assign
Assign location to multiple devices
POST
/devices/location/:revoke
Revoke location for multiple devices
POST
/devices/network-policy/:query
Query network policy for multiple devices
PUT
/devices/radius-proxy/:assign
Assign RADIUS proxy to devices
POST
/devices/network-policy/:assign
Assign network policy to multiple devices
POST
/devices/network-policy/:revoke
Revoke network policy for multiple devices
GET
/devices/network-policy/{policyId}
List assigned devices for network policy
POST
/devices/country-code/:assign
Assign a country code to devices
POST
/devices/os/:change
Change device OS mode
PUT
/devices/ibeacon
Change iBeacon settings for devices
GET
/devices/stats
Get device stats
GET
/devices/{id}
Get device info for a specific device
DELETE
/devices/{id}
Delete a device
POST
/devices/{id}/:manage
Change admin state to 'Managed' for a device
POST
/devices/{id}/:unmanage
Change admin state to 'Unmanaged' for a device
POST
/devices/{id}/:cli
Send CLI to a device
POST
/devices/{id}/:reboot
Reboot a device
POST
/devices/{id}/:reset
[LRO] Reset a device to factory default
PUT
/devices/{id}/hostname
Change hostname for a device
PUT
/devices/{id}/description
Change description for a device
GET
/devices/{id}/location
Get location for a device
PUT
/devices/{id}/location
Assign location to a device
DELETE
/devices/{id}/location
Revoke location for a device
GET
/devices/{id}/network-policy
Get network policy for a device
PUT
/devices/{id}/network-policy
Assign network policy to a device
DELETE
/devices/{id}/network-policy
Revoke network policy for a device
POST
/devices/{id}/ssid/:override
Override SSID for a device
GET
/devices/{id}/ssid/status
Get SSID status for a device
POST
/devices/{id}/ssid/status/:change
Enable or disable SSID for a device
GET
/devices/{id}/alarms
List alarms for a device
GET
/devices/{id}/history/cpu-mem
Get device CPU/memory usage history
GET
/devices/{id}/ibeacon
Get the device iBeacon setting
GET
/devices/{id}/iot
Get the device IoT Wireless Interface settings
POST
/devices/{id}/iot/:enable
Enable IoT Wireless Interface settings on device
POST
/devices/{id}/iot/:disable
Disable IoT Wireless Interface settings on device
GET
/devices/digital-twin
List Digital Twin product information
POST
/devices/{id}/bounce-port
Bounce port of a device
POST
/devices/{id}/monitor/:refresh
Monitor refresh device information
GET
/devices/{id}/monitor/refresh/status
Monitor refresh device information status
GET
/devices/installation-report
Get Installation devices
POST
/devices/{id}/thread/commissioner/:start
Start the Thread Commissioner
POST
/devices/{id}/thread/commissioner/:stop
Stop the Thread Commissioner
GET
/devices/radio-information
List radio information
GET
/devices/{id}/gallery-image
Download device gallery image
GET
/devices/{id}/client-monitor
Get client monitor setting of a device
PUT
/devices/{id}/client-monitor
Configure client monitor setting of a device
DELETE
/devices/{id}/client-monitor
Delete client monitor setting for a device
GET
/devices/{id}/ftm-settings
Get FTM Settings by device ID
PUT
/devices/{id}/ftm-settings
Configure (create / update) device FTM Settings
DELETE
/devices/{id}/ftm-settings
Delete FTM Settings by device ID
GET
/devices/{id}/radio-operating-mode
Get device radio operating modes
PUT
/devices/{id}/radio-operating-mode
Configure radio operating mode of a device
GET
/devices/status
Get the status of devices (online/offline)
POST
/devices/rm-devices-connection-status
Get Device connection status
POST
/devices/rm-devices-page
[LRO] List RM Devices Page
POST
/devices/rm-devices-metadata
Get Metadata Information for given Device
GET
/devices/rm-devices-stack/{stackId}
Get Stack Member Info for given Stack
POST
/devices/rm-devices-page/export
[LRO] Export RM devices page
GET
/devices/reports/{id}
Download the Export CSV file for Device Status
POST
/devices/actions-support-metadata
Get metadata for supported device actions
POST
/devices/:ssh-active-sessions
List SSH active sessions
POST
/devices/thread/commissioner/start
Start the Thread Commissioner by Building IDs
POST
/devices/thread/commissioner/stop
Stop the Thread Commissioner by Building IDs
Schemas 134
The contract defines 134 schemas that model the data the API accepts and returns. The most detailed are RmDeviceIcons (24 properties), XiqDeviceLocation (13 properties), RmDeviceMetadataResponse (12 properties), XiqDeviceIbeacon (11 properties). Each schema is shown below with its type and property counts.
XiqExtremeDevice
object
Extreme/Aerohive device to onboard
4 properties
1 required
XiqDeviceIot
object
The device IoT profile Wireless Interface settings.
2 properties
1 required
XiqDeviceIbeacon
object
The device iBeacon settings.
11 properties
7 required
XiqLocationEntity
XiqIotpMaBleScanApplication
object
The BLE Scan application
PagedXiqRadioEntity
XiqHttpServer
object
3 properties
1 required
XiqDeviceNullField
string
XiqIotpMaBleScan
object
2 properties
XiqDeviceLicenseTier
string
The Device License Tier Enum.
XiqWirelessWlan
XiqDeviceAfcRadioData
object
The device AFC Radio columns
5 properties
XiqRadioEntity
object
ExtremeCloud IQ Radio Information per device
2 properties
1 required
XiqIotpMaBleBeaconApplication
object
The BLE Beacon application
RmDeviceConnectionStatusResponse
object
10 properties
XiqIotpMaBleScanIBeacon
object
3 properties
1 required
XiqAssignDevicesLocationRequest
object
Device location assignment for multiple devices
2 properties
2 required
XiqDigitalTwinDevice
object
The Digital Twin device to onboard.
6 properties
3 required
XiqDeviceStats
object
3 properties
XiqIotApplicationSupported
string
IoT profile supported type.
XiqOnboardError
string
The onboard error code
PagedRmXiqDevice
XiqZsubelement
object
3 properties
2 required
XiqBounceDevicePortResponse
XiqAdvancedOnboardDeviceRequest
object
The payload to advanced onboard devices
7 properties
XiqOnboardDeviceRequest
object
The payload to onboard devices
6 properties
RmDeviceStackInfoResponse
object
Generic ExtremeCloud IQ Device model
5 properties
XiqWirelessClient
object
ExtremeCloud IQ BSS and Network Data
4 properties
4 required
XiqDeviceLevelSsidStatus
object
The SSID status
2 properties
2 required
XiqWirelessIfName
string
The one or multiple ssid on wifi interfaces (example:wifi0 or wifi1) to be disabled/enabled, cannot be empty or no SSID will be disabled or enabled.
XiqCountryCode
string
The country code.
XiqDigitalTwinVimModule
string
The Digital Twin VIM modules.
XiqIotpTgWhiteListEntry
object
2 properties
2 required
XiqVossDevice
object
VSP Operating System Software (VOSS) device to onboard
4 properties
1 required
XiqDellDevice
object
Dell device to onboard
5 properties
2 required
XiqSsidStatus
string
PagedXiqDigitalTwinProducts
XiqAssignDevicesNetworkPolicyRequest
object
Device network policy assignment for multiple devices
2 properties
2 required
XiqThreadStopCommissionerByBuildingsRequest
object
The stop commissioner service request based on buildings.
3 properties
XiqDigitalTwinDevices
object
Digital Twin devices to onboard
1 property
XiqWingDevices
object
ExtremeWireless (WiNG) devices to onboard
1 property
1 required
XiqDigitalTwinOnboardDevice
object
The Digital Twin device to onboard.
4 properties
1 required
XiqThreadStartCommissionerByBuildingsRequest
object
The start commissioner service request based on buildings.
4 properties
XiqBounceDevicePortData
XiqErrorParams
object
Error parameters
2 properties
XiqDeviceFilter
object
The filter to get matched devices
1 property
XiqIotpMaBleBeaconAppType
string
The BLE Beacon application type.
XiqDigitalTwinModel
string
The Digital Twin device model.
XiqError
object
6 properties
3 required
XiqDeviceCpuMemoryUsage
object
Get time series of the average device cpu and memory usage
3 properties
XiqPage
object
4 properties
4 required
XiqCliResponseCode
string
The CLI response code
XiqNetworkPolicy
XiqIotpMaBleScanGeneric
object
3 properties
1 required
XiqConfigureRadioOperatingModeRequest
object
Request to configure Radio Operating mode settings for AP device
2 properties
1 required
XiqIotProfileRequest
object
The IoT Profile
XiqChangeDevicesIbeaconRequest
object
The request to update the existing devices' iBeacon settings or create the settings if they have not already been created.
11 properties
1 required
XiqDeviceField
string
XiqAhDeviceSimulatedType
string
XiqIotpMaBleScanEddystoneUrl
object
2 properties
1 required
XiqMonitorRefresh
object
Device refresh information response
1 property
XiqBounceDevicePortRequest
object
The request for bounce port for the given device id.
2 properties
1 required
XiqIotpMaBleScanAppType
string
The BLE Scan application type.
XiqThreadStartCommissionerRequest
object
Start the Thread Commissioner on a thread router device.
2 properties
XiqDeviceWirelessInterfaceEntry
object
Wireless Interface settings entry.
2 properties
1 required
XiqChangeDevicesOsModeRequest
object
The request for change the device(s) OS mode.
2 properties
2 required
XiqIotApplicationId
string
IoT application identifiers.
XiqDevicesSshActiveSessions
object
The Ssh Active Sessions Data
8 properties
XiqCliOutput
object
The CLI output
3 properties
2 required
XiqDeviceLocationAssignment
object
Device location assignment
5 properties
1 required
XiqFtmSettings
XiqDeviceAlarm
object
The device alarm view
7 properties
XiqAdvancedOnboardDeviceResponse
object
The response for advanced onboard devices
2 properties
XiqExtremeDevices
object
Extreme/Aerohive devices to onboard
1 property
1 required
XiqDeviceStatus
object
2 properties
RmCountryCodeName
object
Country Code Name
2 properties
XiqThreadBuilding
object
The building where thread devices are located.
1 property
XiqIotpMaBleBeacon
object
1 property
XiqDeviceLocation
object
Device location info
13 properties
5 required
XiqAssignDevicesCountryCodeRequest
object
Device country-code assignment for multiple devices
2 properties
2 required
XiqExosDevice
object
ExtremeXOS (EXOS) device to onboard
4 properties
1 required
XiqDeviceMonitorRefreshFunction
string
The device monitor refresh function, route, mac.
XiqDeviceAdminState
string
XiqFailureOnboardDevice
object
The fail onboard device
2 properties
1 required
XiqAfcApStatus
string
Status of AP AFC.
XiqDeviceRadioOperatingMode
string
Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band com…
RmDevicePage
XiqDevice
RmDeviceMetadataResponse
object
Generic ExtremeCloud IQ Device model
12 properties
XiqFtmSettingsRequest
object
Fine Time Measurement (FTM) settings for 802.11mc device support.
6 properties
3 required
XiqRadio
object
ExtremeCloud IQ Radio Information associated to a device
8 properties
6 required
XiqBounceDevicePortOperationResult
XiqDigitalTwinProducts
object
The Digital Twin product information.
4 properties
3 required
XiqThreadStopCommissionerRequest
object
Stop the Thread Commissioner on a thread router device.
1 property
XiqUpdateDeviceLevelSsidStatus
object
The request for disable/enable device level ssid.
3 properties
3 required
XiqWgs84
object
3 properties
3 required
XiqExosDevices
object
ExtremeXOS (EXOS) devices to onboard
1 property
1 required
XiqSsidSecurityType
string
XiqVossDevices
object
VSP Operating System Software (VOSS) devices to onboard
1 property
1 required
XiqDeviceClientMonitor
object
Device-specific client monitor setting
2 properties
1 required
XiqSortOrder
string
XiqWingDevice
object
ExtremeWireless (WiNG) device to onboard
5 properties
2 required
XiqIotProfileMultiApplication
object
4 properties
2 required
XiqDeviceInstallationReportResponse
object
The device installation response
11 properties
11 required
RmDeviceIcons
object
Device icons status
24 properties
XiqIotpMaBleScanVendor
object
3 properties
1 required
RmDeviceActionEnum
string
RmDeviceSortField
string
All available device sort fields MAC = Device MAC Address SN = Device Serial Number
XiqDigitalTwinFeatLicense
string
The Digital Twin feature licenses.
XiqZsubelementAboveFloor
object
2 properties
2 required
XiqSuccessOnboardDevice
object
The success onboard device
2 properties
2 required
XiqBaseEntity
object
3 properties
3 required
XiqDeviceView
string
The logic collections of device fields BASIC: ID, ORGID, SERIALNUMBER, SERVICETAG, MACADDRESS, SIMULATED, DEVICEFUNCTION, PRODUCTTYPE, HOSTNAME, IPADDRESS, SOF…
XiqDeviceFunction
string
The device function, such as AP, Router, Switch, etc.
XiqAfcPowerMode
string
AFC Power Mode
XiqAhDeviceLicenseType
string
The Device License Type Enum.
XiqIotProfileThreadGateway
object
4 properties
2 required
XiqDeviceGeolocation
XiqIotpMaBleBeaconEddystoneUrl
object
5 properties
2 required
XiqSendCliResponse
object
The response for sending CLIs to devices
1 property
XiqIotpMaBleScanVendorType
string
The BLE Scan Vendor types for BLE Scan applications.
XiqDigitalTwinMake
string
The Digital Twin device make.
XiqDellDevices
object
Dell devices to onboard
1 property
1 required
XiqIotpMaBleBeaconIBeacon
object
7 properties
4 required
XiqIotpMaBleScanDestination
object
The BLE Scan destination.
1 property
XiqViqEntity
XiqDeviceSortField
string
All available device sort fields MAC = Device MAC Address SN = Device Serial Number
PagedXiqDevice
XiqDeviceLevelSsid
object
The ssid/passphrase for device level ssid to override
3 properties
1 required
XiqMonitorRefreshStatus
object
The monitor refresh status
3 properties
PagedXiqDeviceAlarm
XiqLocationLegend
object
The simple location information
2 properties
XiqDeviceMonitorRefreshStatus
string
The device monitor refresh status.
XiqSendCliRequest
object
The request for sending CLIs to devices
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extreme Networks 12
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
#Device