Sign in

v4

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

Get device info for a specific device

Get device info for a specific device.

get/devices/{id}

Path parameters

idinteger required

The device ID

Query parameters

viewsXiqDeviceView[]

The views to return device fields (Check details at XiqDeviceView schema)

fieldsXiqDeviceField[]

The device fields to return

Response

OK

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

org_idinteger

The organization identifier, valid when enabling HIQ feature

serial_numberstring

The device serial number, valid for all non-HAC devices

service_tagstring

The device service tag, valid for all HAC devices

mac_addressstring

The device MAC address

device_function'AP' | 'ROUTER' | 'ROUTER_AS_L2_VPN_GATEWAY' | 'ROUTER_AS_L3_VPN_GATEWAY' | 'SWITCH' | 'SWITCH_HAC' | 'SWITCH_DELL' | 'L2_VPN_GATEWAY' | 'L3_VPN_GATEWAY' | 'IQ_CONTROLLER'

The device function, such as AP, Router, Switch, etc.

product_typestring

The product type, such as: AP_230, BR_100, NX9600, etc.

hostnamestring

The device hostname

ip_addressstring

The device IPv4 address

software_versionstring

The device OS software version

device_admin_state'NEW' | 'BOOTSTRAP' | 'STAGED' | 'MANAGED' | 'UNMANAGED'
connectedboolean

The device connection status

last_connect_timestring date-time

The device last connect time

network_policy_namestring

The network policy name for the device

network_policy_idinteger

The network policy ID for the device

primary_ntp_server_addressstring

The primary NTP server address for the device

primary_dns_server_addressstring

The primary DNS server address for the device

subnet_maskstring

The subnet mask for the device

default_gatewaystring

The default gateway for the device

ipv6_addressstring

The ipv6 address for the device

ipv6_netmaskinteger

The ipv6 netmask for the device

simulatedboolean

The device is simulated or not

display_versionstring

The display version for the device

active_clientsinteger

The active client count for the device

location_idinteger

The location ID for the device

country_codeinteger

The assigned country code on the device

descriptionstring

The device description

system_up_timeinteger

The device uptime

config_mismatchboolean

Config audit status(MATCHED or UNMATCHED)

managed_bystring

The managed application for the device

thread0_eui64string

Thread router EUI64

thread0_ext_macstring

Thread router extended MAC address

mgt_vlaninteger

Management VLAN

images_namesstring[]

List of images assigned to this device

visibleboolean

The visible status of a device in a floor.

subscription_licensestring

The Subscription License of the device.

Example response

{
  "locations": [
    {
      "folder_type": "SITE"
    }
  ]
}