List Cloud and Enterprise Agents
GET {{baseUrl}}/agents?aid=1234&expand=cluster-member&agentTypes=enterprise
Returns a list of all agents available to your ThousandEyes account, including both Enterprise and Cloud Agents.
If an agent is an Enterprise Agent, this endpoint returns the agent’s public and private IP addresses, as well as the public network where the agent is located.
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. | |
agentTypes | string | Specifies the type of agent to request. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
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"}}}