ThousandEyes API v6
ThousandEyes API v6

Get an Agent

ThousandEyes API v6 has been deprecated as of May 27, 2024. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.

GET /v6/endpoint-agents/{agent_id}

Returns information about the agent with a given id.

Parameters

Querystring

  • 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

  • {agent_id} corresponds the unique ID of an endpoint agent, obtained from the /endpoint-agents endpoint
  • There is no request body for this request

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/endpoint-agents/5d0764ac-7e42-4ec8-a0d4-39fc53edccba.json \
  -u {email}:{authToken}

Response

Returns information about the agent with a given id. See Listing all agents for details of each field.

Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Sat, 25 Aug 2018 17:03:50 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 240
X-Organization-Rate-Limit-Remaining: 237
X-Organization-Rate-Limit-Reset: 1535216640
Strict-Transport-Security: max-age=31536000
X-Content-Type-Options: nosniff
X-Server-Name: 1-3

Body

json
Copy{
  "endpointAgents": [
    {
      "agentId": "5d0764ac-7e42-4ec8-a0d4-39fc53edccba",
      "agentName": "test agent 1",
      "computerName": "Windows machine",
      "osVersion": "Microsoft Windows 10 Enterprise",
      "kernelVersion": "10.0.18362",
      "manufacturer": "LENOVO",
      "model": "20HR000FUS",
      "lastSeen": "2020-02-20 23:56:43",
      "status": "enabled",
      "deleted": false,
      "version": "0.191.0",
      "createdTime": "2017-06-29 22:05:36",
      "numberOfClients": 3,
      "publicIP": "13.227.74.44",
      "location": {
        "latitude": 51.51130676269531,
        "longitude": -0.271392822265625,
        "locationName": "London, England, UK"
      },
      "clients": [
        {
          "userProfile": {
            "userName": "pzielinski"
          },
          "browserExtensions": [
            {
              "browser": "CHROME",
              "profile": "Profile 1",
              "version": "1.11.0",
              "installed": true,
              "enabled": true,
              "active": true
            }
          ]
        }
      ],
      "totalMemory": "16384 MB",
      "agentType": "enterprise",
      "vpnProfiles": [
        {
          "vpnGatewayAddress": "18.64.79.52",
          "vpnType": "CiscoAnyConnect",
          "vpnClientAddresses": [
            "10.136.56.58"
          ],
          "vpnClientNetworkRange": [
            "10.136.32.0/19"
          ]
        }
      ],
      "networkInterfaceProfiles": [
        {
          "interfaceName": "en0",
          "addressProfiles": [
            {
              "addressType": "UNIQUE_LOCAL",
              "ipAddress": "192.168.1.64",
              "prefixLength": 24,
              "gateway": "192.168.1.254",
              "routerHardwareAddress": "5c:b1:3e:46:1c:84"
            }
          ],
          "hardwareType": "WIRELESS",
          "wirelessProfile": {
            "bssid": "5c:b1:3e:46:1c:87",
            "ssid": "PLUSNET-2CNJ-5ghz",
            "rssi": -56,
            "channel": 48,
            "phyMode": "802.11ac"
          }
        },
        {
          "interfaceName": "utun4",
          "addressProfiles": [
            {
              "addressType": "UNIQUE_GLOBAL",
              "ipAddress": "2a01:4b00:bd04:d000:1c63:3302:4092:220d",
              "prefixLength": 64,
              "gateway": "fe80::6620:9fff:fe11:58f6",
              "routerHardwareAddress": "64:20:9f:11:58:f6"
            }
          ],
          "hardwareType": "VIRTUAL"
        }
      ],
      "asnDetails": {
          "asNumber": 394101,
          "asName": "ThousandEyes, Inc."
      }
    }
  ]
}

For more information on our response status codes, see the response status codes documentation.

Next