ThousandEyes API v6
ThousandEyes API v6

List all Scheduled Tests by Type

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

Returns a list of all endpoint scheduled tests of the type specified, configured in ThousandEyes. The list does not contain saved events.

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

  • {testType} corresponds to any of the following options:
    • agent-to-server
    • http-server
  • There is no request body for this request.

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/endpoint-tests/http-server.json \
  -u {email}:{authToken}

Response

Sends back an array of tests matching the requested test type. See Scheduled Endpoint Test Metadata page for information on fields returned by this endpoint.

Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Sat, 25 Aug 2018 17:03:54 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: 238
X-Organization-Rate-Limit-Reset: 1535216640
Strict-Transport-Security: max-age=31536000
X-Content-Type-Options: nosniff
X-Server-Name: 1-1

Body

json
Copy{
    "endpointTest": [
        {
            "agentSelectorConfig": {
                "agentIds": ["LAPTOP-MAC-AGENT", "PC-WINDOWS-AGENT"],
                "agentSelectorType": "SPECIFIC_AGENTS",
                "labelIds": [],
                "maxMachines": 25
            },
            "alertsEnabled": 0,
            "apiLinks": [...],
            "authType": "NONE",
            "bandwidthMeasurements": 0,
            "bgpMeasurements": 0,
            "createdBy": "API Sandbox User (noprely@thousandeyes.com)",
            "createdDate": "2018-08-18 18:33:23",
            "enabled": 1,
            "flagPing": true,
            "flagTraceroute": false,
            "followRedirects": 1,
            "httpTargetTime": 1000,
            "httpTimeLimit": 5000,
            "httpVersion": 1,
            "interval": 60,
            "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)",
            "modifiedDate": "2018-08-25 17:22:54",
            "mtuMeasurements": 0,
            "networkMeasurements": 1,
            "port": 443,
            "protocol": "TCP",
            "savedEvent": 0,
            "server": "developer.thousandeyes.com",
            "sslVersion": "Auto",
            "sslVersionId": 0,
            "testId": 273,
            "testName": "Developer Reference",
            "type": "http-server",
            "url": "https://developer.thousandeyes.com/",
            "useNtlm": 0,
            "usePublicBgp": 0,
            "username": "",
            "verifyCertificate": 1
        },
        ...
    ]
}

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

Next