---
title: "Get Device List Metadata"
method: POST
path: "/devices/rm-devices-metadata"
tags: ["Device"]
---

# Get Device List Metadata

`POST /devices/rm-devices-metadata`

Retrieve metadata information about devices.

## Query parameters

- `deviceCategory` 'WIRED' | 'WIRELESS' | 'TPME' | 'APPLIANCES'
- `adminStates` XiqDeviceAdminState[]
- `deviceTypes` XiqDeviceType[]
- `includeUnassigned` boolean

## Request body

- XiqRmSiteIdsRequest — Request body for site id filter
  - `site_ids` integer[] — List of site ids to filter

## Response `200`

OK

- XiqRmDeviceMetadataResponse — RM Metadata Response Class
  - `default_gateway` string[] — The device default gateway
  - `software_version` string[] — The device OS software version
  - `product_type` object — The product type map, eg. Key - AP_350, Value(displayed on UI) - AP350
  - `device_admin_state` XiqDeviceAdminState[] — The device admin state
  - `country_code` integer[] — The assigned country code on the device
  - `managed_by` string[] — The managed application for the device
  - `display_managed_by` object — The display managed by map
  - `sim_type` XiqDeviceType[] — The device type - REAL or SIMULATED
  - `country_code_name` XiqCountryCodeName[] — The assigned country name on the device
    - `country_code` integer
    - `country_name` string
  - `network_policy` string[] — The network policy applied to the device
  - `uplink_speeds` string[] — The Eth0 and Eth1 port speed
  - `serial_number` string[] — The serial number of the device
  - `copilot_license_statuses` XiqCopilotLicenseStatus[] — The Copilot license status of the device
  - `anchor_ap` boolean[] — Distinct values present for the Anchor AP icon filter in the matched device set.
  - `locally_managed` boolean[] — Distinct values present for the Locally Managed icon filter in the matched device set.
  - `afc_status` string[] — Distinct AFC status values present in the matched device set (e.g., AVAILABLE, PENDING).
  - `device_update_unsuccessful` boolean[] — Distinct values present for the Device Update Unsuccessful icon filter in the matched device set.
  - `provisioned_device` boolean[] — Distinct values present for the Provisioned Device icon filter in the matched device set.
  - `configuration_roll_back` boolean[] — Distinct values present for the Configuration Roll Back icon filter in the matched device set.
  - `undetermined` boolean[] — Distinct values present for the Undetermined icon filter in the matched device set.
  - `configured_at_device_level` boolean[] — Distinct values present for the Configured At Device Level icon filter in the matched device set.
  - `monitoring_unassociated_clients` boolean[] — Distinct values present for the Monitoring Unassociated Clients icon filter in the matched device set.
  - `switch_stack` boolean[] — Distinct values present for the Switch Stack icon filter in the matched device set.
  - `switch_stack_warning` boolean[] — Distinct values present for the Switch Stack Warning icon filter in the matched device set.
  - `radsec_proxy_server` boolean[] — Distinct values present for the Radsec Proxy Server icon filter in the matched device set.
  - `sensor_mode_interface` boolean[] — Distinct values present for the Sensor Mode Interface icon filter in the matched device set.
  - `spectrum_intelligence` boolean[] — Distinct values present for the Spectrum Intelligence icon filter in the matched device set.
  - `vpn_server` string[] — Distinct VPN Server status values present in the matched device set (e.g., UP, DOWN, UP_DOWN).
  - `vpn_client` string[] — Distinct VPN Client status values present in the matched device set (e.g., UP, DOWN, UP_DOWN).
  - `fabric_attach` boolean[] — Distinct values present for the Fabric Attach icon filter in the matched device set.
  - `fabric_attach_issue` boolean[] — Distinct values present for the Fabric Attach Issue icon filter in the matched device set.
  - `digital_twin` boolean[] — Distinct values present for the Digital Twin icon filter in the matched device set.
  - `managed_by_extreme_iot` boolean[] — Distinct values present for the Managed By Extreme IoT icon filter in the matched device set.
  - `swap_for_real_device` boolean[] — Distinct values present for the Swap for Real Device icon filter in the matched device set.
  - `configuration_pending` boolean[] — Distinct values present for the Configuration Pending icon filter in the matched device set.
  - `connected` boolean[] — Distinct values present for the connected icon filter in the matched device set.
  - `config_mismatch` boolean[] — Distinct values present for the Configuration mismatch icon filter in the matched device set.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)