Qodex.ai

List endpoint agents

GET {{baseUrl}}/endpoint/agents?max=5&cursor=&aid=1234&expand=clients,vpnProfiles,networkInterfaceProfiles&includeDeleted=false&useAllPermittedAids=false&agentName=myagent-1234&computerName=DESKTOP-45AE8

Retrieves a list of endpoint agents in a given account group.

If there are no agents in the specified account group, it returns an empty array.

Request Params

KeyDatatypeRequiredDescription
maxnumber(Optional) Maximum number of objects to return.
cursornull(Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter.
aidnumberA unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
expandstringThis optional parameter allows you to control the expansion of test resources associated with the agent. By default, no expansion occurs when this query parameter is omitted.
To expand the "clients" resource, include the query parameter ?expand=clients.

For multiple expansions, you have two options:

  • Separate the values with commas. For example, ?expandAgent=clients,tasks.
  • Specify the parameter multiple times. For example, ?expandAgent=clients&expandAgent=tasks.

This parameter offers flexibility for users to customize the expansion of specific resources related to the agent. | | includeDeleted | boolean | | When requesting entities, set to true if you want to see deleted entities. | | useAllPermittedAids | boolean | | Set to true to load data from all accounts the user has access to. | | agentName | string | | Returns only agents with the specified name. This is an exact match only. | | computerName | string | | Returns only agents with the specified computer name. This is an exact match only. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"totalAgents":1,"agents":[{"id":"861b7557-cd57-4bbb-b648-00bddf88ef49","aid":"1234","name":"Office Printer","computerName":"DESKJET-123","osVersion":"Version 10.15.2 (Build 19C57)","platform":"mac","kernelVersion":"Darwin 19.2.0","manufacturer":"Apple, Inc.","model":"MacBookAir7,2","lastSeen":"2022-05-26T23:37:16Z","status":"enabled","deleted":true,"version":"0.123.4","createdAt":"2022-05-26T23:37:16Z","numberOfClients":3,"publicIP":"88.45.2.123","location":{"latitude":51.51279,"longitude":-0.09184,"locationName":"London"},"clients":[{"userProfile":{"userName":"joeblogs32"},"browserExtensions":[{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":true,"active":false,"error":""},{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":false,"active":false,"error":""}]},{"userProfile":{"userName":"joeblogs32"},"browserExtensions":[{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":true,"active":false,"error":""},{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":true,"active":true,"error":""}]}],"totalMemory":"16384 MB","agentType":"endpoint","vpnProfiles":[{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"ut qui","vpnType":"cisco-anyconnect","vpnGatewayAddress":"exercitation"},{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"nulla sint fugiat","vpnType":"cisco-anyconnect","vpnGatewayAddress":"Excepteur"}],"networkInterfaceProfiles":[{"interfaceName":"en0","addressProfiles":[{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"},{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"}],"hardwareType":"wireless","ethernetProfile":{"linkSpeed":52113540},"wirelessProfile":{"bssid":"00:11:22:aa:bb:cc","ssid":"GuestWiFi","rssi":-36,"channel":48,"phyMode":"802.11ac"}},{"interfaceName":"en0","addressProfiles":[{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"},{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"}],"hardwareType":"wireless","ethernetProfile":{"linkSpeed":6801919},"wirelessProfile":{"bssid":"00:11:22:aa:bb:cc","ssid":"GuestWiFi","rssi":-36,"channel":48,"phyMode":"802.11ac"}}],"asnDetails":{"asNumber":5089,"asName":"Virgin Media Limited"},"licenseType":"essentials","tcpDriverAvailable":true,"npcapVersion":"ipsum in nostrud","_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"sint nulla","deprecation":"quis","name":"voluptate laboris ad proident","profile":"et cillum est nulla","title":"et","hreflang":"sint quis consectetur"}}},{"id":"861b7557-cd57-4bbb-b648-00bddf88ef49","aid":"1234","name":"Office Printer","computerName":"DESKJET-123","osVersion":"Version 10.15.2 (Build 19C57)","platform":"mac","kernelVersion":"Darwin 19.2.0","manufacturer":"Apple, Inc.","model":"MacBookAir7,2","lastSeen":"2022-05-26T23:37:16Z","status":"enabled","deleted":false,"version":"0.123.4","createdAt":"2022-05-26T23:37:16Z","numberOfClients":3,"publicIP":"88.45.2.123","location":{"latitude":51.51279,"longitude":-0.09184,"locationName":"London"},"clients":[{"userProfile":{"userName":"joeblogs32"},"browserExtensions":[{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":false,"active":true,"error":""},{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":false,"active":true,"error":""}]},{"userProfile":{"userName":"joeblogs32"},"browserExtensions":[{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":false,"active":false,"error":""},{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":true,"active":false,"error":""}]}],"totalMemory":"16384 MB","agentType":"endpoint","vpnProfiles":[{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"cupidatat consectetur sed in","vpnType":"cisco-anyconnect","vpnGatewayAddress":"aliqua id Excepteur voluptate dolore"},{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"magna","vpnType":"cisco-anyconnect","vpnGatewayAddress":"veniam eiusmod aliqua commodo Duis"}],"networkInterfaceProfiles":[{"interfaceName":"en0","addressProfiles":[{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"},{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"}],"hardwareType":"wireless","ethernetProfile":{"linkSpeed":58468602},"wirelessProfile":{"bssid":"00:11:22:aa:bb:cc","ssid":"GuestWiFi","rssi":-36,"channel":48,"phyMode":"802.11ac"}},{"interfaceName":"en0","addressProfiles":[{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"},{"addressType":"unique-local","ipAddress":"2001:db8:3333:4444:5555:6666:7777:8888","prefixLength":24,"gateway":"192.168.0.254","routerHardwareAddress":"5c:b1:3e:46:1c:84"}],"hardwareType":"wireless","ethernetProfile":{"linkSpeed":-16276109},"wirelessProfile":{"bssid":"00:11:22:aa:bb:cc","ssid":"GuestWiFi","rssi":-36,"channel":48,"phyMode":"802.11ac"}}],"asnDetails":{"asNumber":5089,"asName":"Virgin Media Limited"},"licenseType":"essentials","tcpDriverAvailable":true,"npcapVersion":"minim sint","_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"incididunt ut in","deprecation":"quis ullamco","name":"consequat quis sed","profile":"esse","title":"nulla et in","hreflang":"aliqua"}}}],"_links":{"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"ex","deprecation":"eu velit nulla","name":"ut tempor qui es","profile":"incididunt enim qui","title":"aliqua fugiat anim est","hreflang":"nisi"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"cillum esse nostrud anim","deprecation":"anim tempor esse in","name":"labore ea in pariatur","profile":"reprehenderit aliquip","title":"ex occaecat ipsum","hreflang":"ut in aliqua"}}}