ThousandEyes API v6
ThousandEyes API v6

List Agent Proxies

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.

Returns a list of all agent proxies available under your account group in ThousandEyes.

Parameters

Querystring

  • format=json|xml optional, specifies the format of output requested. See [Output Formats][overview-outputformats] 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][overview-accountcontext] for more information

Request

  • no request body

Example

$ curl https://api.thousandeyes.com{{ site.version_url_prefix_request }}/agents/proxies.json \ -u {email}:{authToken}

Response

Sends back an array of agent proxies, including proxyId, which can be used by other areas of the API.

Field Data Type Units Notes
proxyId integer n/a unique ID of proxy
aid integer n/a account id that this proxy configuration belongs to
proxyName string n/a Name of the proxy
proxyType string n/a The type of proxy. Can be STATIC or PAC
proxyLocation string n/a The location of the proxy. If proxyType is 'Static' location will be hostname:port. If it is PAC, the URL where PAC file can be obtained.
proxyUser string n/a Username for proxy authentication
proxyPassword string n/a password for proxy authentication
proxyBypassList array n/a A list of hostnames, network prefixes, or wildcards used to determine which test targets should not be proxied. Empty if all tests should be proxied.
proxyAuthType array n/a The type of authentication the proxy requires
flagLocal boolean n/a True if this proxy configuration represents what was configured in the agent's config file, false if the proxy configuration was created in the app.
lastModified string n/a Last modification timestamp of the proxy. Expressed in UTC: yyyy-MM-dd hh:mm:ss
Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Mon, 09 May 2016 16:04:24 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 240
X-Organization-Rate-Limit-Remaining: 229
X-Organization-Rate-Limit-Reset: 1493294160
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-2

Body

json
Copy{
    "agentProxies": [
        {
            "proxyId": 1074,
            "aid": 11,
            "proxyName": "Test Proxy - Auth Type - BASIC",
            "proxyType": "STATIC",
            "proxyLocation": "agentsproxy.stg.thousandeyes.com:3128",
            "proxyUser": "",
            "proxyPassword": "",
            "proxyBypassList": [],
            "proxyAuthType": "BASIC",
            "flagLocal": true,
            "lastModified": "2018-05-31 00:40:25"
        },
        {
            "proxyId": 1081,
            "aid": 11,
            "proxyName": "Test_proxy",
            "proxyType": "STATIC",
            "proxyLocation": "proxy.thousandeyes.com:3128",
            "proxyUser": "user2",
            "proxyPassword": "pass2",
            "proxyBypassList": [
                "10.0.0.0/16",
                "*.thousandeyes.com"
            ],
            "proxyAuthType": "PROXY_AUTH_TYPE_UNKNOWN",
            "flagLocal": false,
            "lastModified": "2019-06-07 23:47:03"
        },
        {
            "proxyId": 1092,
            "aid": 11,
            "proxyName": "Proxy Name - 1234",
            "proxyType": "PAC",
            "proxyLocation": "http://10.100.21.32/takemeto32.pac",
            "proxyUser": "User2",
            "proxyPassword": "pass3",
            "proxyBypassList": [],
            "proxyAuthType": "BASIC",
            "flagLocal": true,
            "lastModified": "2018-07-31 19:53:27"
        }
    ]
}

For error responses, see the response status codes documentation.

Next