Qodex.ai

Add member to Enterprise Agent cluster

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

Adding a member to an Enterprise Agent cluster converts a standalone Enterprise Agent to an Enterprise Agent cluster. If the agent represented by the path {agentId} is not already a cluster, it will be converted to a cluster.

The response will be a single Enterprise Agent Cluster. The converted Enterprise Agents will become cluster members, and can be returned using the ?expand=cluster-member parameter.

This endpoint requires users to have the Edit agents in account group permission.

Upon successful cluster creation, the response includes:

  • Information about the new cluster in the response body.

  • Each cluster member receives a unique memberId within the cluster.

  • The memberId value is not linked to the original agentId used in the request URL or POST body.

  • The cluster name is based on the agent whose agentId is present in the request URL.

Example - converting a single agent curl -X POST https://api.thousandeyes.com/v7/agents/64965/cluster/assign -H "Authorization: Bearer $Bearer_token" `

Example - converting multiple agents curl https://api.thousandeyes.com/v7/agents/64965/cluster/assign \ '{"agents":[ "2277", "1234" ]}' \ -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

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

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

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"}}}