ThousandEyes API v6
ThousandEyes API v6

Get a Test

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/tests/{testId}

Returns a details for a test, including test type, name, intervals, targets, alert rules and agents.

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

  • {testId} the ID of the test you wish to retrieve
  • There is no request body for this request.

Response

Sends back all metadata for the requested test. See Test metadata page for more information on fields returned by this endpoint.

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/tests/817.json \
  -u {email}:{authToken}
Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Wed, 19 Apr 2017 13:30:42 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: 228
X-Organization-Rate-Limit-Reset: 1492608660
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-2

Body

json
Copy{
    "test": [
        {
            "enabled": 1,
            "savedEvent": 0,
            "liveShare": 0,
            "testId": 817,
            "testName": "http://www.thousandeyes.com",
            "type": "http-server",
            "interval": 900,
            "url": "http://www.thousandeyes.com",
            "alertsEnabled": 1,
            "alertRules": [
                {
                    "ruleId": 302,
                    "ruleName": "BGP alert rule",
                    "expression": "((reachability < 100%) && (changes > 0))",
                    "recipient": [
                        "API Sandbox User (noreply@thousandeyes.com)"
                    ],
                    "alertType": "BGP"
                }
            ],            
            "agents": [
                {
                    "agentId": 12,
                    "agentName": "Hong Kong",
                    "location": "Hong Kong",
                    "countryId": "HK",
                    "ipAddresses": [
                        "124.248.207.183"
                    ],
                    "prefix": "124.248.207.0/24",
                    "network": "SunnyVision Limited (AS 38478)",
                    "agentType": "Cloud
                },
                ...
            ],
            "modifiedDate": "2013-05-11 02:02:21",
            "networkMeasurements": 1,
            "createdBy": "API Sandbox User (noreply@thousandeyes.com)",
            "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)",
            "createdDate": "2012-06-28 19:33:12",
            "apiLinks": [...]
        }
    ]
}

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

Next