Skip to content

Latest commit

 

History

History
188 lines (135 loc) · 13.3 KB

README.md

File metadata and controls

188 lines (135 loc) · 13.3 KB
Raw

endpoint-tests

Endpoint Tests API

  • API version: 7.0.21

Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.

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>endpoint-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:endpoint-tests:<version>"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

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

Getting Started

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

import com.thousandeyes.sdk.endpoint.*;
import com.thousandeyes.sdk.endpoint.client.*;
import com.thousandeyes.sdk.endpoint.tests.model.*;
import com.thousandeyes.sdk.endpoint.tests.AgentToServerEndpointDynamicTestsApi;

public class AgentToServerEndpointDynamicTestsApiExample {

    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();

        AgentToServerEndpointDynamicTestsApi apiInstance = new AgentToServerEndpointDynamicTestsApi(defaultClient);
        DynamicTestRequest dynamicTestRequest = new DynamicTestRequest(); // DynamicTestRequest | 
        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.
        try {
            DynamicTest result = apiInstance.createAgentToServerEndpointDynamicTest(dynamicTestRequest, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentToServerEndpointDynamicTestsApi#createAgentToServerEndpointDynamicTest");
            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
AgentToServerEndpointDynamicTestsApi createAgentToServerEndpointDynamicTest POST /endpoint/tests/dynamic-tests/agent-to-server Create endpoint dynamic test
AgentToServerEndpointDynamicTestsApi createAgentToServerEndpointDynamicTestWithHttpInfo POST /endpoint/tests/dynamic-tests/agent-to-server Create endpoint dynamic test
AgentToServerEndpointDynamicTestsApi deleteAgentToServerEndpointDynamicTest DELETE /endpoint/tests/dynamic-tests/agent-to-server/{testId} Delete agent to server dynamic test
AgentToServerEndpointDynamicTestsApi deleteAgentToServerEndpointDynamicTestWithHttpInfo DELETE /endpoint/tests/dynamic-tests/agent-to-server/{testId} Delete agent to server dynamic test
AgentToServerEndpointDynamicTestsApi getAgentToServerEndpointDynamicTest GET /endpoint/tests/dynamic-tests/agent-to-server/{testId} Retrieve endpoint dynamic test
AgentToServerEndpointDynamicTestsApi getAgentToServerEndpointDynamicTestWithHttpInfo GET /endpoint/tests/dynamic-tests/agent-to-server/{testId} Retrieve endpoint dynamic test
AgentToServerEndpointDynamicTestsApi getAgentToServerEndpointDynamicTests GET /endpoint/tests/dynamic-tests/agent-to-server List endpoint dynamic tests
AgentToServerEndpointDynamicTestsApi getAgentToServerEndpointDynamicTestsWithHttpInfo GET /endpoint/tests/dynamic-tests/agent-to-server List endpoint dynamic tests
AgentToServerEndpointDynamicTestsApi updateAgentToServerEndpointDynamicTest PATCH /endpoint/tests/dynamic-tests/agent-to-server/{testId} Update agent to server dynamic test
AgentToServerEndpointDynamicTestsApi updateAgentToServerEndpointDynamicTestWithHttpInfo PATCH /endpoint/tests/dynamic-tests/agent-to-server/{testId} Update agent to server dynamic test
AgentToServerEndpointScheduledTestsApi createAgentToServerEndpointScheduledTest POST /endpoint/tests/scheduled-tests/agent-to-server Creates agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi createAgentToServerEndpointScheduledTestWithHttpInfo POST /endpoint/tests/scheduled-tests/agent-to-server Creates agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi deleteAgentToServerEndpointScheduledTest DELETE /endpoint/tests/scheduled-tests/agent-to-server/{testId} Delete agent to server scheduled test
AgentToServerEndpointScheduledTestsApi deleteAgentToServerEndpointScheduledTestWithHttpInfo DELETE /endpoint/tests/scheduled-tests/agent-to-server/{testId} Delete agent to server scheduled test
AgentToServerEndpointScheduledTestsApi getAgentToServerEndpointScheduledTest GET /endpoint/tests/scheduled-tests/agent-to-server/{testId} Retrieve agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi getAgentToServerEndpointScheduledTestWithHttpInfo GET /endpoint/tests/scheduled-tests/agent-to-server/{testId} Retrieve agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi getAgentToServerEndpointScheduledTests GET /endpoint/tests/scheduled-tests/agent-to-server List agent to server endpoint scheduled tests
AgentToServerEndpointScheduledTestsApi getAgentToServerEndpointScheduledTestsWithHttpInfo GET /endpoint/tests/scheduled-tests/agent-to-server List agent to server endpoint scheduled tests
AgentToServerEndpointScheduledTestsApi updateAgentToServerEndpointScheduledTest PATCH /endpoint/tests/scheduled-tests/agent-to-server/{testId} Update agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi updateAgentToServerEndpointScheduledTestWithHttpInfo PATCH /endpoint/tests/scheduled-tests/agent-to-server/{testId} Update agent to server endpoint scheduled test
EndpointScheduledTestsApi getEndpointScheduledTests GET /endpoint/tests/scheduled-tests List endpoint scheduled tests
EndpointScheduledTestsApi getEndpointScheduledTestsWithHttpInfo GET /endpoint/tests/scheduled-tests List endpoint scheduled tests
HttpServerEndpointScheduledTestsApi createHttpServerEndpointScheduledTest POST /endpoint/tests/scheduled-tests/http-server Create HTTP server endpoint scheduled test
HttpServerEndpointScheduledTestsApi createHttpServerEndpointScheduledTestWithHttpInfo POST /endpoint/tests/scheduled-tests/http-server Create HTTP server endpoint scheduled test
HttpServerEndpointScheduledTestsApi deleteHttpServerEndpointScheduledTest DELETE /endpoint/tests/scheduled-tests/http-server/{testId} Delete HTTP server scheduled test
HttpServerEndpointScheduledTestsApi deleteHttpServerEndpointScheduledTestWithHttpInfo DELETE /endpoint/tests/scheduled-tests/http-server/{testId} Delete HTTP server scheduled test
HttpServerEndpointScheduledTestsApi getHttpServerEndpointScheduledTest GET /endpoint/tests/scheduled-tests/http-server/{testId} Retrieves HTTP server endpoint scheduled test
HttpServerEndpointScheduledTestsApi getHttpServerEndpointScheduledTestWithHttpInfo GET /endpoint/tests/scheduled-tests/http-server/{testId} Retrieves HTTP server endpoint scheduled test
HttpServerEndpointScheduledTestsApi getHttpServerEndpointScheduledTests GET /endpoint/tests/scheduled-tests/http-server List HTTP server endpoint scheduled tests
HttpServerEndpointScheduledTestsApi getHttpServerEndpointScheduledTestsWithHttpInfo GET /endpoint/tests/scheduled-tests/http-server List HTTP server endpoint scheduled tests
HttpServerEndpointScheduledTestsApi updateHttpServerEndpointScheduledTest PATCH /endpoint/tests/scheduled-tests/http-server/{testId} Update HTTP server endpoint scheduled test
HttpServerEndpointScheduledTestsApi updateHttpServerEndpointScheduledTestWithHttpInfo PATCH /endpoint/tests/scheduled-tests/http-server/{testId} Update HTTP server endpoint scheduled 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