Converting to an agent (multiple member)

POST https://{{base_url}}/v6/agents/{{agentId}}/remove-from-cluster.json

Agent cluster - Converting to an agent

Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s).

This endpoint can only be used for Enterprise Agent clusters, and only by users with the Edit agents in account group permission.

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} in the request URL corresponds to the unique ID of an Enterprise Agent cluster being converted to a standalone Enterprise Agent(s).

Request notes:

  • {agentId} can be obtained from the /v6/agents endpoint

POST Data

  • One or multiple (comma-separated) memberId values representing all the agents that belong to and will be removed from the cluster, enclosed in square brackets.
  • Cluster member IDs can be obtained from the /v6/agents API endpoint (the memberId field inside the clusterMembers array).

Request Body

[80001, 80002, 80003]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring