Update Enterprise Agent
PUT {{baseUrl}}/agents/:agentId?aid=1234&expand=cluster-member
Updates details for an Enterprise Agent. This endpoint can only be used for Enterprise Agents, and only for users in a role that permits modification of Enterprise Agents.
Important notes related to agent modification on tests: * if an agent is removed from a test, the modification date for tests using that agent at the time it was removed will be changed. * If an agent is removed from an entire account group, then all tests using this agent in the removed account group will be updated to reflect the removed agent. * If a removed agent is the final remaining agent on a test, then the test will be disabled when the agent is removed.
Users can update the following fields:
* agentName: String representation of an agent. No two agents can have the same display name.
* enabled: Boolean representation of agent state.
* accountGroups: An array of account group ids. See v7/account-groups to pull a list of account IDs.
* tests: An array of test Is. See v7/tests to retrieve a list tests available in the current account context.
* ipv6Policy: Enum representation of the IP version policy.
* keepBrowserCache: Boolean representation of the Keep browser cache state.
* targetForTests: String representation of the target IP address or domain name. This represents the test destination when agent is acting as a test target in an agent-to-agent test.
* localResolutionPrefixes: This array of strings represents the public IP ranges where the Enterprise Agent performs rDNS (Reverse DNS) lookups. The range should be in CIDR notation, such as 10.1.1.0/24. Please note that a maximum of 5 prefixes is allowed. This only applies to Enterprise Agents and Enterprise Agent clusters.
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 | Optional parameter, off by default. Indicates which agent sub-resource to expand. For example, if you wish to expand the clusterMembers sub-resource, pass the ?expand=cluster-member query. |
Request Body
{"agentName"=>"thousandeyes-stg-va-254", "enabled"=>true, "accountGroups"=>["1234", "1"], "ipv6Policy"=>"force-ipv4", "keepBrowserCache"=>true, "targetForTests"=>"1.1.1.1", "localResolutionPrefixes"=>["10.2.3.3/24", "10.2.3.3/25"], "tests"=>["12313145", "12345"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"agentType":"cloud","ipAddresses":["99.139.65.220","9bbd:8a0a:a257:5876:288b:6cb2:3f36:64ce"],"publicIpAddresses":["192.168.1.78","f9b2:3a21:f25c:d300:03f4:586d:f8d6:4e1c"],"network":"AT\u0026T Services, Inc. (AS 7018)","agentId":"281474976710706","agentName":"thousandeyes-stg-va-254","location":"San Francisco Bay Area","countryId":"US","enabled":true,"prefix":"99.128.0.0/11","verifySslCertificates":true,"tests":[{"interval":60,"alertsEnabled":true,"enabled":true,"createdBy":"user@user.com","createdDate":"2022-07-17T22:00:54Z","description":"ThousandEyes Test","liveShare":false,"modifiedBy":"user@user.com","modifiedDate":"2022-07-17T22:00:54Z","savedEvent":true,"testId":"281474976710706","testName":"ThousandEyes Test","type":"agent-to-server","_links":{"self":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"},"testResults":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}]}},{"interval":60,"alertsEnabled":true,"enabled":true,"createdBy":"user@user.com","createdDate":"2022-07-17T22:00:54Z","description":"ThousandEyes Test","liveShare":false,"modifiedBy":"user@user.com","modifiedDate":"2022-07-17T22:00:54Z","savedEvent":false,"testId":"281474976710706","testName":"ThousandEyes Test","type":"agent-to-server","_links":{"self":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"},"testResults":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}]}}],"labels":[{"labelId":"11","name":"Label name"},{"labelId":"11","name":"Label name"}],"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"aut","deprecation":"fugiat commodo aliquip voluptate","name":"ea Lorem irure Excepteur","profile":"anim tempor mollit","title":"in laborum proident","hreflang":"amet es"}}}