Filter endpoint agents
POST {{baseUrl}}/endpoint/agents/filter?max=5&cursor=&aid=1234&expand=clients,vpnProfiles,networkInterfaceProfiles&includeDeleted=false
Retrieves a list of endpoint agents within the specified account group that match the specified filters.
If no agents meet the filter criteria, the API returns an empty array.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
max | number | (Optional) Maximum number of objects to return. | |
cursor | null | (Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter. | |
aid | number | A 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. | |
expand | string | This 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. |
Request Body
{"searchFilters"=>{"agentName"=>["myagent-1234", "myagent-1234"], "computerName"=>["DESKTOP-45AE8", "DESKTOP-45AE8"], "username"=>["picard"], "platform"=>["mac", "mac"], "osVersion"=>["Version 10.15.2", "Version 10.15.2"], "locationCountryISO"=>["FR", "FR"], "locationSubdivision1Code"=>["ENG", "ENG"], "locationCity"=>["Paris", "Paris"], "licenseType"=>["essentials", "essentials"]}, "thresholdFilter"=>{"filters"=>[{"name"=>"last-seen-ms", "value"=>28326477.89569065, "operator"=>"gte"}, {"name"=>"last-seen-ms", "value"=>69398083.60802838, "operator"=>"gte"}], "conditionalOperator"=>"and"}, "searchSort"=>[{"sort"=>"platform", "order"=>"desc"}, {"sort"=>"city", "order"=>"desc"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
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":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":true,"active":false,"error":""},{"browser":"edge","profile":"Profile 1","version":"0.123.0","enabled":true,"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":false,"error":""}]}],"totalMemory":"16384 MB","agentType":"endpoint","vpnProfiles":[{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"minim officia labore nisi","vpnType":"cisco-anyconnect","vpnGatewayAddress":"culpa l"},{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"sint aliqua irure id","vpnType":"cisco-anyconnect","vpnGatewayAddress":"anim dolor fugiat"}],"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":66638858},"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":3805390},"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":false,"npcapVersion":"amet occaecat","_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"ullamco non anim laborum","deprecation":"et amet tempor","name":"non","profile":"ullamco ut est culpa","title":"laboris veniam Excepteur irure","hreflang":"reprehenderit consequat"}}},{"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":false,"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":false,"active":true,"error":""}]}],"totalMemory":"16384 MB","agentType":"endpoint","vpnProfiles":[{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"aliqua eiusmod","vpnType":"cisco-anyconnect","vpnGatewayAddress":"tempor in dolor in"},{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"ut","vpnType":"cisco-anyconnect","vpnGatewayAddress":"dolor enim nulla"}],"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":87130464},"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":16763529},"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":false,"npcapVersion":"dolor Lorem nostrud reprehenderit","_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"nulla ","deprecation":"magna do nulla quis","name":"id ut non","profile":"occaecat ullamco","title":"ipsum eu","hreflang":"in aute"}}}],"_links":{"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"qui elit cillum","deprecation":"dolor","name":"enim fugiat","profile":"mollit et do nulla","title":"pariatur nisi","hreflang":"irure quis Duis ad dolore"}}}