Retrieve Cloud and Enterprise Agent
GET {{baseUrl}}/agents/:agentId?aid=1234&expand=cluster-member
Returns details for an agent, including assigned tests.
For Enterprise Agents, this endpoint returns additional details, including utilization data, assigned accounts, a list of account groups the agent is assigned to, and utilization details.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
aid | number | A 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. | |
expand | string | Optional 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
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"}}}