README.md

tests

Tests API

• API version: 7.0.15

This API supports listing, creating, editing, and deleting Cloud and Enterprise Agent (CEA) based tests.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 11+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependencies>
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>tests</artifactId>
        <version>version</version>
    </dependency>
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>client</artifactId>
        <version>version</version>
    </dependency>

    <!-- Example only, you can use your own client implementation -->
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>client-native</artifactId>
        <version>version</version>
    </dependency>
</dependencies>

Gradle users

Add this dependency to your project's build file:

implementation "com.thousandeyes.sdk:client:<version>"
implementation "com.thousandeyes.sdk:client-native:<version>" #Example only, you can use your own client implementation
implementation "com.thousandeyes.sdk:tests:<version>"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/tests-version.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.thousandeyes.sdk.*;
import com.thousandeyes.sdk.client.*;
import com.thousandeyes.sdk.tests.model.*;
import com.thousandeyes.sdk.tests.AgentToAgentApi;

public class AgentToAgentApiExample {

    public static void main(String[] args) {
        // Configure clients using the `defaultClient` object, such as
        // overriding the host and port, timeout, etc. In this example we are using the NativeApiClient
        // but you can use your own client implementation
        ApiClient defaultClient = NativeApiClient
                .builder()
                .baseUri("https://api.thousandeyes.com/v7")
                .bearerToken("<bearer-token>")
                .build();

        AgentToAgentApi apiInstance = new AgentToAgentApi(defaultClient);
        UpdateAgentToAgentTest updateAgentToAgentTest = new UpdateAgentToAgentTest(); // UpdateAgentToAgentTest | 
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        List<Expand> expand = Arrays.asList(); // List<Expand> | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.
        try {
            AgentToAgentTest result = apiInstance.createAgentToAgentTest(updateAgentToAgentTest, aid, expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentToAgentApi#createAgentToAgentTest");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class	Method	HTTP request	Description
AgentToAgentApi	createAgentToAgentTest	POST /tests/agent-to-agent	Create Agent to Agent test
AgentToAgentApi	createAgentToAgentTestWithHttpInfo	POST /tests/agent-to-agent	Create Agent to Agent test
AgentToAgentApi	deleteAgentToAgentTest	DELETE /tests/agent-to-agent/{testId}	Delete Agent to Agent test
AgentToAgentApi	deleteAgentToAgentTestWithHttpInfo	DELETE /tests/agent-to-agent/{testId}	Delete Agent to Agent test
AgentToAgentApi	getAgentToAgentTest	GET /tests/agent-to-agent/{testId}	Get Agent to Agent test
AgentToAgentApi	getAgentToAgentTestWithHttpInfo	GET /tests/agent-to-agent/{testId}	Get Agent to Agent test
AgentToAgentApi	getAgentToAgentTests	GET /tests/agent-to-agent	List Agent to Agent tests
AgentToAgentApi	getAgentToAgentTestsWithHttpInfo	GET /tests/agent-to-agent	List Agent to Agent tests
AgentToAgentApi	updateAgentToAgentTest	PUT /tests/agent-to-agent/{testId}	Update Agent to Agent test
AgentToAgentApi	updateAgentToAgentTestWithHttpInfo	PUT /tests/agent-to-agent/{testId}	Update Agent to Agent test
AgentToServerApi	createAgentToServerTest	POST /tests/agent-to-server	Create Agent to Server test
AgentToServerApi	createAgentToServerTestWithHttpInfo	POST /tests/agent-to-server	Create Agent to Server test
AgentToServerApi	deleteAgentToServerTest	DELETE /tests/agent-to-server/{testId}	Delete Agent to Server test
AgentToServerApi	deleteAgentToServerTestWithHttpInfo	DELETE /tests/agent-to-server/{testId}	Delete Agent to Server test
AgentToServerApi	getAgentToServerTest	GET /tests/agent-to-server/{testId}	Get Agent to Server test
AgentToServerApi	getAgentToServerTestWithHttpInfo	GET /tests/agent-to-server/{testId}	Get Agent to Server test
AgentToServerApi	getAgentToServerTests	GET /tests/agent-to-server	List Agent to Server tests
AgentToServerApi	getAgentToServerTestsWithHttpInfo	GET /tests/agent-to-server	List Agent to Server tests
AgentToServerApi	updateAgentToServerTest	PUT /tests/agent-to-server/{testId}	Update Agent to Server test
AgentToServerApi	updateAgentToServerTestWithHttpInfo	PUT /tests/agent-to-server/{testId}	Update Agent to Server test
AllTestTypesApi	getTests	GET /tests	List configured tests
AllTestTypesApi	getTestsWithHttpInfo	GET /tests	List configured tests
ApiApi	createApiTest	POST /tests/api	Create API test
ApiApi	createApiTestWithHttpInfo	POST /tests/api	Create API test
ApiApi	deleteApiTest	DELETE /tests/api/{testId}	Delete API test
ApiApi	deleteApiTestWithHttpInfo	DELETE /tests/api/{testId}	Delete API test
ApiApi	getApiTest	GET /tests/api/{testId}	Get API test
ApiApi	getApiTestWithHttpInfo	GET /tests/api/{testId}	Get API test
ApiApi	getApiTests	GET /tests/api	List API tests
ApiApi	getApiTestsWithHttpInfo	GET /tests/api	List API tests
ApiApi	updateApiTest	PUT /tests/api/{testId}	Update API test
ApiApi	updateApiTestWithHttpInfo	PUT /tests/api/{testId}	Update API test
BgpApi	createBgpTest	POST /tests/bgp	Create BGP test
BgpApi	createBgpTestWithHttpInfo	POST /tests/bgp	Create BGP test
BgpApi	deleteBgpTest	DELETE /tests/bgp/{testId}	Delete BGP test
BgpApi	deleteBgpTestWithHttpInfo	DELETE /tests/bgp/{testId}	Delete BGP test
BgpApi	getBgpTest	GET /tests/bgp/{testId}	Get BGP test
BgpApi	getBgpTestWithHttpInfo	GET /tests/bgp/{testId}	Get BGP test
BgpApi	getBgpTests	GET /tests/bgp	List BGP tests
BgpApi	getBgpTestsWithHttpInfo	GET /tests/bgp	List BGP tests
BgpApi	updateBgpTest	PUT /tests/bgp/{testId}	Update BGP test
BgpApi	updateBgpTestWithHttpInfo	PUT /tests/bgp/{testId}	Update BGP test
DnsServerApi	createDnsServerTest	POST /tests/dns-server	Create DNS Server test
DnsServerApi	createDnsServerTestWithHttpInfo	POST /tests/dns-server	Create DNS Server test
DnsServerApi	deleteDnsServerTest	DELETE /tests/dns-server/{testId}	Delete DNS Server test
DnsServerApi	deleteDnsServerTestWithHttpInfo	DELETE /tests/dns-server/{testId}	Delete DNS Server test
DnsServerApi	getDnsServerTest	GET /tests/dns-server/{testId}	Get DNS Server test
DnsServerApi	getDnsServerTestWithHttpInfo	GET /tests/dns-server/{testId}	Get DNS Server test
DnsServerApi	getDnsServerTests	GET /tests/dns-server	List DNS Server tests
DnsServerApi	getDnsServerTestsWithHttpInfo	GET /tests/dns-server	List DNS Server tests
DnsServerApi	updateDnsServerTest	PUT /tests/dns-server/{testId}	Update DNS Server test
DnsServerApi	updateDnsServerTestWithHttpInfo	PUT /tests/dns-server/{testId}	Update DNS Server test
DnsTraceApi	createDnsTraceTest	POST /tests/dns-trace	Create DNS Trace test
DnsTraceApi	createDnsTraceTestWithHttpInfo	POST /tests/dns-trace	Create DNS Trace test
DnsTraceApi	deleteDnsTraceTest	DELETE /tests/dns-trace/{testId}	Delete DNS Trace test
DnsTraceApi	deleteDnsTraceTestWithHttpInfo	DELETE /tests/dns-trace/{testId}	Delete DNS Trace test
DnsTraceApi	getDnsTraceTest	GET /tests/dns-trace/{testId}	Get DNS Trace test
DnsTraceApi	getDnsTraceTestWithHttpInfo	GET /tests/dns-trace/{testId}	Get DNS Trace test
DnsTraceApi	getDnsTraceTests	GET /tests/dns-trace	List DNS Trace tests
DnsTraceApi	getDnsTraceTestsWithHttpInfo	GET /tests/dns-trace	List DNS Trace tests
DnsTraceApi	updateDnsTraceTest	PUT /tests/dns-trace/{testId}	Update DNS Trace test
DnsTraceApi	updateDnsTraceTestWithHttpInfo	PUT /tests/dns-trace/{testId}	Update DNS Trace test
DnssecApi	createDnsSecTest	POST /tests/dnssec	Create DNSSEC test
DnssecApi	createDnsSecTestWithHttpInfo	POST /tests/dnssec	Create DNSSEC test
DnssecApi	deleteDnsSecTest	DELETE /tests/dnssec/{testId}	Delete DNSSEC test
DnssecApi	deleteDnsSecTestWithHttpInfo	DELETE /tests/dnssec/{testId}	Delete DNSSEC test
DnssecApi	getDnsSecTest	GET /tests/dnssec/{testId}	Get DNSSEC test
DnssecApi	getDnsSecTestWithHttpInfo	GET /tests/dnssec/{testId}	Get DNSSEC test
DnssecApi	getDnsSecTests	GET /tests/dnssec	List DNSSEC tests
DnssecApi	getDnsSecTestsWithHttpInfo	GET /tests/dnssec	List DNSSEC tests
DnssecApi	updateDnsSecTest	PUT /tests/dnssec/{testId}	Update DNSSEC test
DnssecApi	updateDnsSecTestWithHttpInfo	PUT /tests/dnssec/{testId}	Update DNSSEC test
FtpServerApi	createFtpServerTest	POST /tests/ftp-server	Create FTP Server test
FtpServerApi	createFtpServerTestWithHttpInfo	POST /tests/ftp-server	Create FTP Server test
FtpServerApi	deleteFtpServerTest	DELETE /tests/ftp-server/{testId}	Delete FTP Server test
FtpServerApi	deleteFtpServerTestWithHttpInfo	DELETE /tests/ftp-server/{testId}	Delete FTP Server test
FtpServerApi	getFtpServerTest	GET /tests/ftp-server/{testId}	Get FTP Server test
FtpServerApi	getFtpServerTestWithHttpInfo	GET /tests/ftp-server/{testId}	Get FTP Server test
FtpServerApi	getFtpServerTests	GET /tests/ftp-server	List FTP Server tests
FtpServerApi	getFtpServerTestsWithHttpInfo	GET /tests/ftp-server	List FTP Server tests
FtpServerApi	updateFtpServerTest	PUT /tests/ftp-server/{testId}	Update FTP Server test
FtpServerApi	updateFtpServerTestWithHttpInfo	PUT /tests/ftp-server/{testId}	Update FTP Server test
HttpServerApi	createHttpServerTest	POST /tests/http-server	Create HTTP Server test
HttpServerApi	createHttpServerTestWithHttpInfo	POST /tests/http-server	Create HTTP Server test
HttpServerApi	deleteHttpServerTest	DELETE /tests/http-server/{testId}	Delete HTTP Server test
HttpServerApi	deleteHttpServerTestWithHttpInfo	DELETE /tests/http-server/{testId}	Delete HTTP Server test
HttpServerApi	getHttpServerTest	GET /tests/http-server/{testId}	Get HTTP Server test
HttpServerApi	getHttpServerTestWithHttpInfo	GET /tests/http-server/{testId}	Get HTTP Server test
HttpServerApi	getHttpServerTests	GET /tests/http-server	List HTTP Server tests
HttpServerApi	getHttpServerTestsWithHttpInfo	GET /tests/http-server	List HTTP Server tests
HttpServerApi	updateHttpServerTest	PUT /tests/http-server/{testId}	Update HTTP Server test
HttpServerApi	updateHttpServerTestWithHttpInfo	PUT /tests/http-server/{testId}	Update HTTP Server test
PageLoadApi	createPageLoadTest	POST /tests/page-load	Create Page Load test
PageLoadApi	createPageLoadTestWithHttpInfo	POST /tests/page-load	Create Page Load test
PageLoadApi	deletePageLoadTest	DELETE /tests/page-load/{testId}	Delete Page Load test
PageLoadApi	deletePageLoadTestWithHttpInfo	DELETE /tests/page-load/{testId}	Delete Page Load test
PageLoadApi	getPageLoadTest	GET /tests/page-load/{testId}	Get Page Load test
PageLoadApi	getPageLoadTestWithHttpInfo	GET /tests/page-load/{testId}	Get Page Load test
PageLoadApi	getPageLoadTests	GET /tests/page-load	List Page Load tests
PageLoadApi	getPageLoadTestsWithHttpInfo	GET /tests/page-load	List Page Load tests
PageLoadApi	updatePageLoadTest	PUT /tests/page-load/{testId}	Update Page Load test
PageLoadApi	updatePageLoadTestWithHttpInfo	PUT /tests/page-load/{testId}	Update Page Load test
PathVisualizationInterfaceGroupsApi	createPathVisInterfaceGroups	POST /network/path-vis/interface-groups	Create interface group for path visualization
PathVisualizationInterfaceGroupsApi	createPathVisInterfaceGroupsWithHttpInfo	POST /network/path-vis/interface-groups	Create interface group for path visualization
PathVisualizationInterfaceGroupsApi	deletePathVisInterfaceGroup	DELETE /network/path-vis/interface-groups/{interfaceGroupId}	Delete interface group
PathVisualizationInterfaceGroupsApi	deletePathVisInterfaceGroupWithHttpInfo	DELETE /network/path-vis/interface-groups/{interfaceGroupId}	Delete interface group
PathVisualizationInterfaceGroupsApi	getPathVisInterfaceGroups	GET /network/path-vis/interface-groups	List interface groups for path visualization
PathVisualizationInterfaceGroupsApi	getPathVisInterfaceGroupsWithHttpInfo	GET /network/path-vis/interface-groups	List interface groups for path visualization
PathVisualizationInterfaceGroupsApi	updatePathVisInterfaceGroup	PUT /network/path-vis/interface-groups/{interfaceGroupId}	Update interface group
PathVisualizationInterfaceGroupsApi	updatePathVisInterfaceGroupWithHttpInfo	PUT /network/path-vis/interface-groups/{interfaceGroupId}	Update interface group
SipServerApi	createSipServerTest	POST /tests/sip-server	Create SIP Server test
SipServerApi	createSipServerTestWithHttpInfo	POST /tests/sip-server	Create SIP Server test
SipServerApi	deleteSipServerTest	DELETE /tests/sip-server/{testId}	Delete SIP Server test
SipServerApi	deleteSipServerTestWithHttpInfo	DELETE /tests/sip-server/{testId}	Delete SIP Server test
SipServerApi	getSipServerTest	GET /tests/sip-server/{testId}	Get SIP Server test
SipServerApi	getSipServerTestWithHttpInfo	GET /tests/sip-server/{testId}	Get SIP Server test
SipServerApi	getSipServerTests	GET /tests/sip-server	List SIP Server tests
SipServerApi	getSipServerTestsWithHttpInfo	GET /tests/sip-server	List SIP Server tests
SipServerApi	updateSipServerTest	PUT /tests/sip-server/{testId}	Update SIP Server test
SipServerApi	updateSipServerTestWithHttpInfo	PUT /tests/sip-server/{testId}	Update SIP Server test
VoiceApi	createVoiceTest	POST /tests/voice	Create Voice test
VoiceApi	createVoiceTestWithHttpInfo	POST /tests/voice	Create Voice test
VoiceApi	deleteVoiceTest	DELETE /tests/voice/{testId}	Delete Voice test
VoiceApi	deleteVoiceTestWithHttpInfo	DELETE /tests/voice/{testId}	Delete Voice test
VoiceApi	getVoiceTest	GET /tests/voice/{testId}	Get Voice test
VoiceApi	getVoiceTestWithHttpInfo	GET /tests/voice/{testId}	Get Voice test
VoiceApi	getVoiceTests	GET /tests/voice	List Voice tests
VoiceApi	getVoiceTestsWithHttpInfo	GET /tests/voice	List Voice tests
VoiceApi	updateVoiceTest	PUT /tests/voice/{testId}	Update Voice test
VoiceApi	updateVoiceTestWithHttpInfo	PUT /tests/voice/{testId}	Update Voice test
WebTransactionApi	createWebTransactionsTest	POST /tests/web-transactions	Create Web Transactions test
WebTransactionApi	createWebTransactionsTestWithHttpInfo	POST /tests/web-transactions	Create Web Transactions test
WebTransactionApi	deleteWebTransactionsTest	DELETE /tests/web-transactions/{testId}	Delete Web Transactions test
WebTransactionApi	deleteWebTransactionsTestWithHttpInfo	DELETE /tests/web-transactions/{testId}	Delete Web Transactions test
WebTransactionApi	getWebTransactionsTest	GET /tests/web-transactions/{testId}	Get Web Transactions test
WebTransactionApi	getWebTransactionsTestWithHttpInfo	GET /tests/web-transactions/{testId}	Get Web Transactions test
WebTransactionApi	getWebTransactionsTests	GET /tests/web-transactions	List Web Transactions tests
WebTransactionApi	getWebTransactionsTestsWithHttpInfo	GET /tests/web-transactions	List Web Transactions tests
WebTransactionApi	updateWebTransactionsTest	PUT /tests/web-transactions/{testId}	Update Web Transactions test
WebTransactionApi	updateWebTransactionsTestWithHttpInfo	PUT /tests/web-transactions/{testId}	Update Web Transactions test

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: HTTP Bearer Token authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Author