ThousandEyes API v6
ThousandEyes API v6

Create an Automated Session 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.

POST /v6/endpoint-automated-session-tests/new

Creates a new Endpoint Automated Session test in ThousandEyes, based on properties provided in the POST data. In order to create a new test, the user attempting the creation must be an Account Admin.

Regular users are blocked from using any of the POST-based methods.

Request

  • Request body should contain fields to be set during creation.

Example - AST test

curl
Copy$ curl -i https://api.thousandeyes.com{{ site.version_url_prefix_request }}/endpoint-automated-session-tests/new.json \
  -d '{ "agentSelectorType": "LIST_OF_LABELS",
        "application": "WEBEX",
        "flagPing": true,
        "flagTraceroute": true,
        "interval" : 3600,
        "labelIds": [1, 2, 3],
        "maxMachines": 5,
        "networkProtocol": "ICMP_WITH_TCP_CONNECT",
        "testName": "Network test"
     }' \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -u {email}:{authToken}
Field Data Type Units Notes
agentIds array of strings n/a List of agent ids. Must be set if agentSelectorType == SPECIFIC_AGENTS
agentSelectorType string ANY_AGENT, SPECIFIC_AGENTS, LIST_OF_LABELS Agent selection type: either all agents available, or list of agents, of list of agent labels
application string n/a monitored application, can be one of WEBEX, ZOOM, MSTEAMS
flagPing boolean n/a Optional flag indicating if test should run ping. If not specified, true is used by default
flagTraceroute boolean n/a Optional flag indicating if test should run traceroute. If not specified, true is used by default
interval integer [120, 300, 600, 900, 1800, 3600] Interval in seconds that the test will execute on
labelIds array of longs n/a List of label ids. Must be set if agentSelectorType == LIST_OF_LABELS
maxMachines integer [1-100000] Maximum number of agents which can execute this test
networkProtocol string n/a ICMP, TCP, ICMP_WITH_TCP_CONNECT or PREFER_TCP, default ICMP. If PREFER_TCP is selected, and if an agent doesn't support TCP, then it’s as if the test was configured as ICMP_WITH_TCP_CONNECT.
pathtraceInSession boolean true or false Optional flag indicating if test should perform path trace "in session". This option initiates a TCP session with the target server, and sends path trace packets within the TCP session.
testName string n/a Name of the test

Response

If a test is successfully created, an HTTP/201 CREATED response will be returned, and the test definition will be returned. See the example below.

Response does not include the results of the test. Once the test has been run, results can be retrieved using Endpoint Test Data endpoints. API test data endpoints URLs are provided in test definition output upon test creation. See the example below.

Code Snippet
CopyHTTP/1.1 201 Created
Server: nginx
Date: Mon, 17 Feb 2020 13:41:02 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 600
X-Organization-Rate-Limit-Remaining: 599
X-Organization-Rate-Limit-Reset: 1490622120
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-3

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

Body

json
Copy{
     "automatedSessionTests": [
         {
             "agentSelectorConfig": {
                "agentIds": [],
                "agentSelectorType": "LIST_OF_LABELS",
                "labelIds": [1, 2, 3],
                "maxMachines": 5
              },
              "apiLinks": [
                {
                    "href": "https://api.stg.thousandeyes.com/v6/endpoint-automated-session-tests/9918128",
                    "rel": "self"
                },
                {
                    "href": "https://api.stg.thousandeyes.com/v6/endpoint-data/automated-session-tests/net/metrics/9918128",
                    "rel": "data"
                },
                {
                    "href": "https://api.stg.thousandeyes.com/v6/endpoint-data/automated-session-tests/net/path-vis/9918128",
                    "rel": "data"
                }
              ],
              "application": "WEBEX",
              "bandwidthMeasurements": 0,
              "bgpMeasurements": 0,
              "createdBy": "API User (noprely@thousandeyes.com)",
              "createdDate": "2022-05-06 09:20:27",
              "enabled": 1,
              "flagPing": true,
              "flagTraceroute": true,
              "interval": 60,
              "modifiedBy": "API User (noprely@thousandeyes.com)",
              "modifiedDate": "2022-05-06 09:20:27",
              "mtuMeasurements": 0,
              "networkMeasurements": 1,
              "port": 443,
              "protocol": "ICMP",
              "savedEvent": 0,
              "subinterval": -1,
              "testId": 9918128,
              "testName": " . . .. . . .. ",
              "usePublicBgp": 0
        }
     ]
 }
Next