--- title: "List thread routers" method: GET path: "/thread/routers" tags: ["Thread"] --- # List thread routers `GET /thread/routers` List thread routers with pagination. ## Query parameters - `ids` integer[], required - `page` integer - `limit` integer - `sortField` 'SERIAL_NUMBER' | 'EUI64' | 'EXT_MAC' | 'RLOC16' | 'GLOBAL_IPV6' | 'TX_POWER' | 'REGION' | 'THREAD_PLATFORM' | 'DEVICE_ROLE' | 'ROUTER_INTERFACE_NAME' | 'ROUTER_INTERFACE_IS_ACTIVE' | 'ROUTER_INTERFACE_IS_BROADCAST' | 'ROUTER_INTERFACE_IS_LOOPBACK' | 'ROUTER_INTERFACE_IS_POINT_TO_POINT' | 'ROUTER_INTERFACE_IS_RUNNING' | 'ROUTER_INTERFACE_IS_ARP' | 'ROUTER_INTERFACE_IS_PROMISC' | 'ROUTER_INTERFACE_IS_ALL_MULTI' | 'ROUTER_INTERFACE_IS_MULTICAST' | 'ROUTER_INTERFACE_IS_DYNAMIC' | 'ROUTER_INTERFACE_MTU' | 'ROUTER_INTERFACE_HW_MAC' | 'ROUTER_INTERFACE_IPV4' | 'ROUTER_INTERFACE_IPV4_MASK' | 'ROUTER_INTERFACE_IPV4_BROADCAST' | 'VETH0_INTERFACE_NAME' | 'VETH0_IS_ACTIVE' | 'VETH0_IS_BROADCAST' | 'VETH0_IS_LOOPBACK' | 'VETH0_IS_POINT_TO_POINT' | 'VETH0_IS_RUNNING' | 'VETH0_IS_ARP' | 'VETH0_IS_PROMISC' | 'VETH0_IS_ALL_MULTI' | 'VETH0_IS_MULTICAST' | 'VETH0_IS_DYNAMIC' | 'VETH0_MTU' | 'VETH0_HW_MAC' | 'VETH0_IPV4' | 'VETH0_IPV4_MASK' | 'VETH0_IPV4_BROADCAST' | 'NETWORK_DATA_LENGTH' | 'NETWORK_DATA_MAX_LENGTH' | 'RX_ON_WHEN_IDLE' | 'FULL_THREAD_DEVICE' | 'FULL_NETWORK_DATA' | 'THREAD_VERSION' | 'BUILD_VERSION' | 'API_VERSION' | 'RCP_VERSION' | 'LEADER_PARTITION_ID' | 'LEADER_WEIGHTING' | 'LEADER_FULL_NETWORK_DATA_VERSION' | 'LEADER_STABLE_NETWORK_DATA_VERSION' | 'BORDER_ROUTER_STATE' | 'BORDER_NAT64_LOCAL_PREFIX' | 'BORDER_NAT64_FAVORED_PREFIX' | 'BORDER_NAT64_FAVORED_PREFERENCE' | 'BORDER_NAT64_0MR_LOCAL_PREFIX' | 'BORDER_NAT64_0MR_FAVORED_PREFIX' | 'BORDER_NAT64_0MR_FAVORED_PREFERENCE' | 'BORDER_NAT64_640N_LINK_LOCAL_PREFIX' | 'BORDER_NAT64_640N_LINK_FAVORED_PREFIX' | 'BORDER_NAT64_640N_LINK_FAVORED_PREFERENCE' | 'BACKBONE_BORDER_ROUTER_STATE' | 'BORDER_AGENT_STATE' | 'BORDER_AGENT_UDP_PORT' | 'COMMISSIONER_STATE' | 'NAT64_PREFIX_MANAGER_STATE' | 'NAT64_TRANSLATOR_STATE' | 'NAT64_TRANSLATOR_CIDR' | 'HOSTNAME' — All available thread router sort fields - `sortOrder` 'ASC' | 'DESC' — Sort Order - `views` string[] - `fields` string[] ## Response `200` OK - PagedXiqThreadRouter - `page` integer, required — The current page number - `count` integer, required — The element count of the current page - `total_pages` integer, required — The total page number based on request page size - `total_count` integer, required — The total element count - `data` XiqThreadRouter[] — The data in the current page - `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 --- [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)