ThousandEyes API v6
ThousandEyes API v6

Getting Started

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.

The following sections introduce you to the ThousandEyes API v6 resources and provide instructions to make your first API request. Learn how to retrieve a list of agents and create a network test. Examples will be shown using the command line with cURL.

Standard REST methods are supported on the API, which include POST, GET, and DELETE operations through HTTPS. All payloads to and from the REST interface must be in JSON or XML format.

Below is high-level description of the API resources:

  • Administrative Endpoints - Manage users, accounts, and account groups in the ThousandEyes platform.
  • Agents & Monitors - Manage all agents and retrieve information about BGP monitors available to your ThousandEyes account.
  • Alerts & Notifications - Manage all alerts, alert rules and alert suppression windows.
  • Credentials - Create, retrieve, update and delete credentials for transaction tests.
  • Dashboards - Manage ThousandEyes Dashboards, Widgets and Dashboard snapshots.
  • Endpoint Agents - Create, retrieve, update and delete, transfer, enable, and disable ThousandEyes Endpoint Agents.
  • Endpoint Data - Manage Endpoint data.
  • Endpoint Tests: Manage endpoint agent dynamic and scheduled tests.
  • Endpoint Instant Tests - Create and execute a new endpoint instant scheduled test within ThousandEyes.
  • Endpoint Test Data - Retrieve results for scheduled and dynamic tests on endpoint agents.
  • Instant Tests - Create and run new instant tests.
  • Labels - Create, retrieve, update and delete labels.
  • Reports - Manage reports and report snapshots in ThousandEyes.
  • Snapshots - Create a new test snapshot in ThousandEyes.
  • Test Data - Get test data metrics for Cloud and Enterprise Agent tests.
  • Tests - Create, retrieve, update and delete Cloud and Enterprise Agent (CEA) tests.
  • Usage - Retrieve usage details.

API User Requirements

To use the ThousandEyes API, you must have the following:

  • Your user role must have the API access permission. The three built-in roles (Organization Admin, Account Admin, and Regular User) include this permission by default.

  • You must have a user API token generated by the ThousandEyes platform to authenticate your requests.

Base URI

Every API request will begin with the following Base URI.

Code Snippet
Copyhttps://api.thousandeyes.com/v6/

1. Authorization

In addition to the path URL, an Authorization header must be added to every API request with the following format.

curl
CopyAuthorization: Basic dXNlckBleGFtcGxlLmNvbTpiM3B4a2E2d2d2ODF6Z2h4

Read more about authenticating, including generating an access token here.

2. Retrieve a List of Agents

To create a test, an agent is required. To check which agents are available:

Request

curl
Copycurl -i -XGET https://api.thousandeyes.com/v6/agents.json -H "Authorization: Bearer $BEARER_TOKEN"

Response

json
Copy{ 
    [
        {
        "agentId": 12345,
        "agentName": "Tests",
        "agentType": "Cloud",
        "countryId": "US",
        "targetOnly": 0,
        "ipAddresses": [
            "128.0.0.1"
        ],
        "location": "San Francisco Area",
        "createdDate": "2023-01-25 22:01:45"
        },
        ...
    ]
}

3. Create a Test

From the list of available agents, select one Cloud Agent and use its agentId to create a test:

Request

curl
Copycurl -i -XPOST https://api.thousandeyes.com/v6/tests/agent-to-server/new.json -H "Authorization: Bearer $BEARER_TOKEN" -d '{
        "interval": 60,
        "agents": [
        {"agentId": 12345}
        ],
        "testName": "Sample Test",
        "server": "www.thousandeyes.com",
        "port": 80,
        "alertsEnabled": 0
    }'

Response

json
Copy{
"test": [
    {
    "enabled": 1,
    "testId": 987654,
    "testName": "Sample Test",
    "type": "agent-to-server"
    ...
    }]
}

Try It Out Using Postman Collections

Prefer to use Postman rather than code or the command line? Check out our Postman Collections.

Next