Update endpoint agent
PATCH {{baseUrl}}/endpoint/agents/:agentId?aid=1234&expand=clients,vpnProfiles,networkInterfaceProfiles
Updates the agent with the specified agent_id
. This API supports the modification of the following fields:
name
licenseType
Any attempt to update fields other than those listed above, with a value different from their current value, will result in a 400 Bad Request response.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
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. |
Request Body
{"name"=>"Office Printer", "licenseType"=>"essentials"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"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":true,"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":false,"active":false,"error":""}]}],"totalMemory":"16384 MB","agentType":"endpoint","vpnProfiles":[{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"culpa labore ea","vpnType":"cisco-anyconnect","vpnGatewayAddress":"nostrud in"},{"vpnClientAddresses":["10.100.0.10"],"vpnClientNetworkRange":["10.100.0.0/22"],"interfaceName":"ut veniam mollit","vpnType":"cisco-anyconnect","vpnGatewayAddress":"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":12912682},"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":-78959823},"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":"officia Ut tempor sunt","_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"dolore occaecat ut et","deprecation":"dolor dolor","name":"ex pariatur in adipisicing eiusmod","profile":"eiusmod elit dolore fugiat","title":"consequat","hreflang":"in ad ullam"}}}