Updating an agent

POST https://{{base_url}}/v6/agents/{{agentId}}/update.json

Updating an agent

Updates Enterprise Agent details. Users can update the agent parameters specified under Post Data section.

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.

Optional (Querystring) Parameters

• format=json|xml optional, specifies the format of output requested. See Output Formats for more information
• aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

• {agentId} corresponds the unique ID of an enterprise agent, obtained from the /agents endpoint

Post Data

When POSTing data to the /agents/{agentId}/update endpoint, 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. 0 to disable the agent, 1 to enable the agent. * accountGroups an array of accountGroup objects containing only an aid value, in the format { aid: integer }. See /accounts to pull a list of account IDs * tests an array of test objects containing only a testId value in the format { testId: integer }. See /tests to pull a list of tests available in the current account context. * ipv6Policy string representation of the IP version policy. Can be FORCEIPV4, PREFERIPV6 or FORCE_IPV6. * verifySslCertificates boolean representation of Verify SSL certificates state. 0 to disable, 1 to enable. * keepBrowserCache boolean representation of Keep browser cache state. 0 to disable, 1 to enable. * targetForTests string representation of target IP address or domain name, representing test destination when agent is acting as a test target in an agent-to-agent test

HEADERS