v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB

Device

[LRO] Export RM devices data to CSV

Export RM devices data to a CSV file.

post/devices/rm-devices-page/export

Query parameters

keywordstring

The keyword to search

connectedboolean

The device connect status

adminStatesXiqDeviceAdminState[]

The device admin states

deviceCategory'WIRED' | 'WIRELESS'

The device category - wired, wireless

sortField'HOSTNAME' | 'MAC' | 'SN' | 'CONNECTION_STATUS' | 'OS' | 'PRODUCT_TYPE'

RM Device List Sort fields

The sort field

sortOrder'ASC' | 'DESC'

Sort Order

Sort order (ASC, DESC)

deviceTypesXiqDeviceType[]

The device types to return

configMismatchboolean

Config audit status(MATCHED(false) or UNMATCHED(true))

timezoneOffsetinteger

timezone offset

asyncboolean

Param to include additional columns data corresponding to 'Show Additional Data' option on the Network Devices page

includeUnassignedboolean

Whether to include unassigned devices

copilotLicenseStatusesXiqCopilotLicenseStatus[]

Copilot license status to filter devices

Request body

site_idsinteger[]

List of site ids to filter

snsstring[]

List of device serial numbers to filter

mac_addressesstring[]

List of device MAC addresses to filter

hostnamesstring[]

List of device host names to filter

default_gateway_ipsstring[]

List of device default gateway IPs to filter

product_typesstring[]

List of device product types to filter

firmware_versionsstring[]

List of device firmware versions to filter

country_codesinteger[]

List of country codes to filter

managed_bystring[]

List of entities managing the device to filter

display_managed_bystring[]

List of display values for 'Managed By' shown only in EP1

network_policiesstring[]

List of network policies to filter

Example request

{
  "mac_addresses": [
    "001122334455",
    "AABBCCDDEEFF"
  ],
  "default_gateway_ips": [
    "192.168.1.1",
    "10.0.0.1"
  ]
}

Response

idstring required

The reportId