Qodex.ai

Remove member from Enterprise Agent cluster

POST {{baseUrl}}/agents/:agentId/cluster/unassign?aid=1234&expand=cluster-member

Converts a cluster with a single or multiple Enterprise Agent members back to a standalone Enterprise Agent(s). This endpoint can also be used to remove one or more members from an Enterprise Agent cluster. Removed members revert to being standalone Enterprise Agents. If all members are removed from the cluster, the Enterprise Agent Cluster is deleted.

The response is an list of agents, containing both the Enterprise Agent Cluster (if it still exists), and the removed members, now as standalone Enterprise Agents. This endpoint is exclusive to Enterprise Agent clusters and can be accessed only by users with the Edit agents in account group permission.

On successful completion, the response contains the following information:

  • The updated cluster information is provided in the response body, unless all members are removed from the cluster.

  • Information about each removed member, now a standalone agent.

  • When a non-last member is removed from the cluster, it receives a new agentId value. This new agentId is different from the agentId the agent had before joining the cluster, and it is also unrelated to the memberId value the agent had while being a part of the cluster.

  • If all members are removed from the cluster, the cluster itself is converted back to a standalone Enterprise Agent too. Such standalone agent inherits the old cluster’s agentId value. The last memberId listed in the POST body inherits the cluster’s agentId value.

Example - removing a single member curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \ '{"members":["55974"]}' \ -H "content-type:application/json" \ -H "Authorization: Bearer $Bearer_token"

Example - removing multiple members curl https://api.thousandeyes.com/v7/agents/64965/cluster/unassign \ '{"members":[ "55974", "12313"] }' \ -H "content-type:application/json" \ -H "Authorization: Bearer $Bearer_token"

Request Params

KeyDatatypeRequiredDescription
aidnumberA 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.
expandstringOptional 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

{"members"=>["281474976710706"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"agents":[{"agentType":"enterprise-cluster","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},{"agentType":"enterprise-cluster","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}],"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"do occaecat in ulla","deprecation":"consectetur Duis laborum quis","name":"enim fugiat","profile":"aliqua ipsum ullamco","title":"cupidatat esse nostrud","hreflang":"ad amet proident Excepteur"}}}