Sign in

v4

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

[LRO] RM Device Page

Device List with pagination.

post/devices/rm-devices-page

Query parameters

pageinteger

Page number, min = 1

limitinteger

Page Size, min = 1, max = 100

keywordstring

The keyword to search

connectedboolean

The device connect status

adminStatesXiqDeviceAdminState[]

The device admin states to filter

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

The device category - Wired, Wireless, TPME, Appliances

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

RM Device List Sort fields

The sort field

order'ASC' | 'DESC'

Sort Order

The sort order (ascending by default)

deviceTypesXiqDeviceType[]

The device types to return

configMismatchboolean

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

asyncboolean

Whether to enable async mode

includeUnassignedboolean

Whether to include unassigned devices

stacked_viewboolean

Whether to include only virtual stack (stacked_view = true) or also the stack members (stacked_view = false)

copilotLicenseStatusesXiqCopilotLicenseStatus[]

The copilot license status to filter

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

OK

pageinteger required

The current page number

countinteger required

The element count of the current page

total_pagesinteger required

The total page number based on request page size

total_countinteger required

The total element count

Example response

{
  "data": [
    {
      "system_up_time": 1770280794349,
      "mac_address": "001122334455",
      "device_ip": "10.16.172.199",
      "default_gateway": "10.16.172.199",
      "ipv6_address": "0:0:0:0:0:0:0:0",
      "eth0_uplink_speed": "SPEED_1000M",
      "eth1_uplink_speed": "SPEED_1000M"
    }
  ]
}