v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Device

Get Device List Metadata

Retrieve metadata information about devices.

post/devices/rm-devices-metadata

Query parameters

deviceCategory'WIRED' | 'WIRELESS' | 'TPME' | 'APPLIANCES'

The device category - Wired, Wireless, TPME, Appliances

adminStatesXiqDeviceAdminState[]

The device admin states to filter

deviceTypesXiqDeviceType[]

The device types to return

includeUnassignedboolean

Whether to include unassigned devices

Request body

site_idsinteger[]

List of site ids to filter

Response

OK

default_gatewaystring[]

The device default gateway

software_versionstring[]

The device OS software version

product_typeobject

The product type map, eg. Key - AP_350, Value(displayed on UI) - AP350

device_admin_stateXiqDeviceAdminState[]

The device admin state

country_codeinteger[]

The assigned country code on the device

managed_bystring[]

The managed application for the device

display_managed_byobject

The display managed by map

sim_typeXiqDeviceType[]

The device type - REAL or SIMULATED

network_policystring[]

The network policy applied to the device

uplink_speedsstring[]

The Eth0 and Eth1 port speed

serial_numberstring[]

The serial number of the device

copilot_license_statusesXiqCopilotLicenseStatus[]

The Copilot license status of the device

anchor_apboolean[]

Distinct values present for the Anchor AP icon filter in the matched device set.

locally_managedboolean[]

Distinct values present for the Locally Managed icon filter in the matched device set.

afc_statusstring[]

Distinct AFC status values present in the matched device set (e.g., AVAILABLE, PENDING).

device_update_unsuccessfulboolean[]

Distinct values present for the Device Update Unsuccessful icon filter in the matched device set.

provisioned_deviceboolean[]

Distinct values present for the Provisioned Device icon filter in the matched device set.

configuration_roll_backboolean[]

Distinct values present for the Configuration Roll Back icon filter in the matched device set.

undeterminedboolean[]

Distinct values present for the Undetermined icon filter in the matched device set.

configured_at_device_levelboolean[]

Distinct values present for the Configured At Device Level icon filter in the matched device set.

monitoring_unassociated_clientsboolean[]

Distinct values present for the Monitoring Unassociated Clients icon filter in the matched device set.

switch_stackboolean[]

Distinct values present for the Switch Stack icon filter in the matched device set.

switch_stack_warningboolean[]

Distinct values present for the Switch Stack Warning icon filter in the matched device set.

radsec_proxy_serverboolean[]

Distinct values present for the Radsec Proxy Server icon filter in the matched device set.

sensor_mode_interfaceboolean[]

Distinct values present for the Sensor Mode Interface icon filter in the matched device set.

spectrum_intelligenceboolean[]

Distinct values present for the Spectrum Intelligence icon filter in the matched device set.

vpn_serverstring[]

Distinct VPN Server status values present in the matched device set (e.g., UP, DOWN, UP_DOWN).

vpn_clientstring[]

Distinct VPN Client status values present in the matched device set (e.g., UP, DOWN, UP_DOWN).

fabric_attachboolean[]

Distinct values present for the Fabric Attach icon filter in the matched device set.

fabric_attach_issueboolean[]

Distinct values present for the Fabric Attach Issue icon filter in the matched device set.

digital_twinboolean[]

Distinct values present for the Digital Twin icon filter in the matched device set.

managed_by_extreme_iotboolean[]

Distinct values present for the Managed By Extreme IoT icon filter in the matched device set.

swap_for_real_deviceboolean[]

Distinct values present for the Swap for Real Device icon filter in the matched device set.

configuration_pendingboolean[]

Distinct values present for the Configuration Pending icon filter in the matched device set.

connectedboolean[]

Distinct values present for the connected icon filter in the matched device set.

config_mismatchboolean[]

Distinct values present for the Configuration mismatch icon filter in the matched device set.