Device

[LRO] List devices

List devices with filters and pagination.

get/devices

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/devices
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, min = 1

limitinteger

Page Size, min = 1, max = 100

locationIdinteger

Location Id

connectedboolean

The device connect status

adminStatesXiqDeviceAdminState[]

The device admin states

macAddressesstring[]

The device mac addresses

snsstring[]

The device serial numbers

hostnamesstring[]

The device host names

sortField'MAC' | 'SN'

All available device sort fields<br/><br/>MAC = Device MAC Address<br/>SN = Device Serial Number

The sort field

order'ASC' | 'DESC'

The sort order (ascending by default)

viewsXiqDeviceView[]

The views to return device fields (Check fields for each view at XiqDeviceView schema)

fieldsXiqDeviceField[]

The device fields to return

deviceTypesXiqDeviceType[]

The device types to return

nullField'LOCATION_ID' | 'NETWORK_POLICY_ID'

The device empty field, only returns the selected field that is null

locationIdsinteger[]

The location IDs

asyncboolean

Whether to enable async mode

configMismatchboolean

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

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

Changes

No operation changes recorded.