---
title: "Get thread network topology"
method: GET
path: "/thread/topology"
tags: ["Thread"]
---

# Get thread network topology

`GET /thread/topology`

Get thread routers, neighboring routers and end-devices

## Query parameters

- `networkConfigIds` integer[], required
- `routerFields` string[]
- `routerViews` string[]
- `clientViews` XiqClientView[]
- `clientFields` XiqClientField[]

## Response `200`

OK

- XiqThreadNetworkTopology — The thread network topology
  - `neighbors` XiqThreadRouterNeighbor[]
    - `parent_device_id` integer
    - `child_device_id` integer
    - `connection_status` integer
    - `last_reported_time` integer
  - `routers` XiqThreadRouter[]
    - `id` integer, required — The unique identifier
    - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
    - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `owner_id` integer — The owner id
    - `device_id` integer — The device unique identifier
    - `serial_number` string — The device serial number
    - `eui64` string — The Extended Unique Identifier
    - `ext_mac` string — The Extended Mac Address
    - `rloc16` string — The router RLOC16
    - `global_ipv6` string — The global IPv6 address
    - `tx_power` integer — The transmit power
    - `region` string — The device region
    - `thread_platform` string — The thread platform
    - `device_role` string — The thread device role/state
    - `router_interface` XiqThreadNetworkInterface — The thread veth0 network interface
      - `interface_name` string
      - `is_active` boolean
      - `is_broadcast` boolean
      - `is_loopback` boolean
      - `is_point_to_point` boolean
      - `is_running` boolean
      - `is_arp` boolean
      - `is_promisc` boolean
      - `is_all_multi` boolean
      - `is_multicast` boolean
      - `is_dynamic` boolean
      - `mtu` integer
      - `hw_mac_address` string
      - `ipv4` string
      - `ipv4_mask` string
      - `ipv4_broadcast` string
      - `ipv6_settings` XiqThreadIpv6Setting[]
        - `address` string
        - `scope` string
        - `cast` string
        - `type` string
    - `veth0` XiqThreadNetworkInterface — The thread veth0 network interface
      - `interface_name` string
      - `is_active` boolean
      - `is_broadcast` boolean
      - `is_loopback` boolean
      - `is_point_to_point` boolean
      - `is_running` boolean
      - `is_arp` boolean
      - `is_promisc` boolean
      - `is_all_multi` boolean
      - `is_multicast` boolean
      - `is_dynamic` boolean
      - `mtu` integer
      - `hw_mac_address` string
      - `ipv4` string
      - `ipv4_mask` string
      - `ipv4_broadcast` string
      - `ipv6_settings` XiqThreadIpv6Setting[]
        - `address` string
        - `scope` string
        - `cast` string
        - `type` string
    - `network_data` XiqThreadNetworkData — The thread network data
      - `length` integer
      - `max_length` integer
      - `net_data_on_mesh_prefixes` XiqThreadNetDataPrefix[]
        - `prefix` string
        - `route_preference` string
        - `added_by_rloc16` string
        - `added_by_ext_mac` string
        - `preferred` boolean
        - `slaac` boolean
        - `dhcp` boolean
        - `configure` boolean
        - `default_route` boolean
        - `on_mesh` string
        - `stable` boolean
        - `nd_dns` boolean
        - `dp` boolean
      - `net_data_routes` XiqThreadNetDataRoute[]
        - `prefix` string
        - `nat64` boolean
        - `stable` boolean
        - `route_preference` string
        - `added_by_rloc16` string
        - `added_by_ext_mac` string
      - `net_data_services` XiqThreadNetDataService[]
        - `enterprise_number` integer
        - `service_data` string
        - `server_data` string
        - `stable` boolean
        - `added_by_rloc16` string
        - `added_by_ext_mac` string
    - `thread_mle_link_mode` XiqThreadMleLinkMode — The thread MLE Link Mode configuration
      - `rx_on_when_idle` boolean
      - `full_thread_device` boolean
      - `full_network_data` boolean
    - `thread_version` XiqThreadVersion — The thread version
      - `thread_version` string
      - `build_version` string
      - `api_version` string
      - `rcp_version` string
    - `leader_service` XiqThreadLeaderService — The thread leader service
      - `partition_id` integer
      - `weighting` integer
      - `full_network_data_version` integer
      - `stable_network_data_version` integer
    - `border_router_service` XiqThreadBorderRouterService — The thread border router service
      - `state` string
      - `nat64_local_prefix` string
      - `nat64_favored_prefix` string
      - `nat64_favored_preference` string
      - `nat64_omr_local_prefix` string
      - `nat64_omr_favored_prefix` string
      - `nat64_omr_favored_preference` string
      - `nat64_onlink_local_prefix` string
      - `nat64_onlink_favored_prefix` string
      - `nat64_onlink_favored_preference` string
    - `backbone_border_router_service` XiqThreadBackboneBorderRouterService — The thread backbone border router service
      - `state` string
    - `border_agent_service` XiqThreadBorderAgentService — The thread backbone agent service
      - `state` string
      - `udp_port` integer
    - `commissioner_service` XiqThreadCommissionerService — The commissioner service
      - `state` string
    - `nat64_service` XiqThreadNat64Service — The nat64 service on border router
      - `prefix_manager_state` string
      - `translator_state` string
      - `translator_cidr` string
    - `network_config` XiqThreadNetworkConfig — The thread network configuration and security policy
      - `id` integer — The unique identifier
      - `channel` integer — The network channel
      - `channel_mask` string — The network channel mask
      - `ext_pan_id` string — The unique extended pan id
      - `mesh_local_prefix` string — The mesh local prefix
      - `network_key` string — The thread network key
      - `network_name` string — The thread network name
      - `pan_id` string — The pan id
      - `pskc` string — The Pre-Shared Key for the Commissioner
      - `obtain_network_key_enabled` boolean
      - `native_commissioning_enabled` boolean
      - `routers_enabled` boolean
      - `external_commissioning_enabled` boolean
      - `beacons_enabled` boolean
      - `commercial_commissioning_enabled` boolean
      - `autonomous_enrollment_enabled` boolean
      - `network_key_provisioning_enabled` boolean
      - `non_ccm_routers_enabled` boolean
      - `active_timestamp` integer
    - `active_clients` integer — The count of active connected clients
    - `hostname` string — The device hostname
    - `last_reported` string, date-time — The last reported datetime
    - `thread_connected` boolean — Is router connected to thread network
  - `clients` XiqClient[]
    - `id` integer, required — The unique identifier
    - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
    - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `location_id` integer — The location ID
    - `device_id` integer — The device ID
    - `hostname` string — The hostname of the client
    - `mac_address` string — The MAC address of the client
    - `ip_address` string — The IP address of the client
    - `ipv6_address` string — The IPv6 address of the client
    - `os_type` string — The OS type of the client
    - `username` string — The username of the client.
    - `user_profile_name` string — The user profile name of the client
    - `connected` boolean — Client is connected or not
    - `online_time` string, date-time — The online time for the client
    - `offline_time` string, date-time — The offline time for the client
    - `vlan` integer — The associate VLAN
    - `connection_type` integer — The connection type
    - `ssid` string — The SSID
    - `port` string — The associate device port
    - `org_name` string — The organization name
    - `device_function` integer — The associated device function
    - `device_mac_address` string — The associated device mac address
    - `device_name` string — The associated device name
    - `auth` integer — The authentication type
    - `channel` integer — The channel value
    - `client_health` integer — The health score of client
    - `application_health` integer — The health score of application
    - `radio_health` integer — The health score of radio
    - `network_health` integer — The health score of network
    - `radio_type` integer — The radio type. Represented by an integer code for each standard:<br> 1 - 2.4G<br> 2 - 5G<br> 3 - WIRED<br> 4 - 6G<br> 5 - THREAD
    - `encryption_method` integer — The encryption method, represented by an integer code for each encryption type:<br>-1 - N/A (Not applicable)<br>0 - AES (Advanced Encryption Standard)<br>1 - TKIP (Temporal Key Integrity Protocol)<br>2 - WEP (Wired Equivalent Privacy)<br>3 - NON (No encryption)<br>4 - CCMP (Counter Mode with Cipher Block Chaining Message Authentication Code Protocol)<br>5 - KEYGUARD (Keyguard encryption)<br>6 - WEP128 (128-bit WEP encryption)<br>7 - WEP64 (64-bit WEP encryption)<br>8 - WAPI (WLAN Authentication and Privacy Infrastructure)<br>9 - GCMP256 (256-bit Galois/Counter Mode Protocol)<br>10 - NONE (No encryption)<br>11 - PAP (Password Authentication Protocol)<br>12 - MsCHAP (Microsoft Challenge Handshake Authentication Protocol)<br>13 - EAP-MD5 (Extensible Authentication Protocol - MD5)<br>14 - EAP-TLS (Extensible Authentication Protocol - Transport Layer Security)<br>15 - PEAP (Protected Extensible Authentication Protocol)<br>16 - TTLS (Tunneled Transport Layer Security)<br>17 - TTLS-INNER-TUNNEL (Inner tunnel for TTLS)<br>18 - PEAP-INNER-TUNNEL (Inner tunnel for PEAP)<br>19 - EAP-FAST (Extensible Authentication Protocol - Flexible Authentication via Secure Tunneling)<br>20 - EAP-LEAP (Lightweight Extensible Authentication Protocol)<br>21 - EAP-RSA (Extensible Authentication Protocol - RSA)<br>22 - EAP-SIM (Extensible Authentication Protocol - SIM)<br>23 - EAP-AKA (Extensible Authentication Protocol - AKA)<br>24 - EAP-TEAP (Extensible Authentication Protocol - Tunneled EAP)
    - `mac_protocol` string — The MAC protocol of the client:<br>'N/A'<br>'802.11a'<br>'802.11b'<br>'802.11g'<br>'802.11na'<br>'802.11ng'<br>'802.11ac'<br>'802.11ax-2.4g'<br>'802.11ax-5g'<br>'802.3'<br>'802.11ax-6g'<br>'802.15.4'<br>'802.11be-2g'<br>'802.11be-5g'<br>'802.11be-6g'
    - `interface_name` string — The interface name
    - `bssid` string — The bssid
    - `rssi` integer — The RSSI
    - `snr` integer — The SNR
    - `description` string — The description of client
    - `category` string — The category of client
    - `mobility` string — The client mobility
    - `port_type_name` string — The client port type name
    - `wing_ap` boolean — Wing ap flag
    - `vendor` string — The vendor of client
    - `locations` XiqLocationLegend[] — The detailed location
      - `id` integer — The location ID
      - `name` string — The location name
    - `product_type` string — The Category which describes the Extreme device types(For example:For example:SR_2208P, AP_4000, AP_5010)
    - `alias` string — The alias of the client
    - `th_rloc16` string — The thread client Rloc16
    - `th_child_id` integer — The thread client child ID
    - `th_timeout` integer — The thread client timeout
    - `th_supervision_interval` integer — The thread client Super vision interval
    - `th_netdata_version` integer — The thread client netdata version
    - `th_csl_synced` boolean — The thread client CSL synced
    - `th_ip_addresses` XiqThreadIpv6Setting[] — The thread client IP addresses
      - `address` string
      - `scope` string
      - `cast` string
      - `type` string
    - `th_router_last_reported` string, date-time — The last reported datetime by thread router
    - `thread_connected` boolean — Is client connected to thread network
    - `make` string — The Manufacturer of the client associated device
    - `os_version` string — The OS version of the client associated device
    - `connected_to` string — The device name which client is connected to
    - `connection_duration` integer — The client's connection duration
    - `captive_web_portal` string — Captive Web Portal

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)