Dashboard Wired Client Health

Wired client health grid

Changed on

Returns the client health grid of wired devices based on the provided filters. You can filter the results by sites.

post/dashboard/wired/client-health/grid

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/dashboard/wired/client-health/grid
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, min = 1

limitinteger

Page Size, min = 1, max = 100

keywordstring

The keyword to search

sortField'UNSPECIFIED' | 'CONNECTION_STATUS' | 'CLIENT_HOSTNAME' | 'SITE' | 'BUILDING' | 'FLOOR' | 'IPV4' | 'IPV6' | 'PORT_NUMBER' | 'PORT_NUMBER_SWITCH_NAME' | 'VLAN' | 'OPERATING_SYSTEM' | 'MAC' | 'USERNAME' | 'INSTANT_PORT_PROFILE' | 'TOTAL_CONGESTION' | 'TOTAL_UNICAST' | 'TOTAL_MULTICAST' | 'TOTAL_BROADCAST' | 'TOTAL_PORT_ERRORS'

Sort Field

sortOrder'ASC' | 'DESC'

Sort Order

Request body

site_idsinteger[]

The site ids

device_idsinteger[]

The device ids

filter_fieldXiqWiredClientHealthFilter[]

The filters available for client health grid

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": [
    {
      "client_ip": "10.16.172.199",
      "ipv4": "10.16.172.199",
      "ipv6": "0:0:0:0:0:0:0:0",
      "mac": "001122334455"
    }
  ]
}

Changes

  • 242a0e1b1b40Revision changes
    • breaking

      for the query request parameter sortField, default value UNSPECIFIED was added

    • breaking

      for the query request parameter sortOrder, default value was changed from ASC to DESC