Adding members (multiple agents)

POST https://{{base_url}}/v6/agents/{{agentId}}/add-to-cluster.json

Agent cluster - Adding members

Adds a new member (or multiple members) to an Enterprise Agent cluster.

This endpoint can only be used 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 to which new agent(s) will be added.

Request notes:

  • {agentId} can be obtained from the /v6/agents endpoint.
  • If the agent represented by the {agentId} is not already a cluster, it is converted to a cluster.

POST Data

  • One or multiple (comma-separated) agentId values representing agents that should be added to the cluster, enclosed in square brackets.
  • Each agentId must represent an agent of the Enterprise type (as shown by the agentType field in agent details).

Request Body

[80001, 80002, 80003]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring