Skip to content

README.md

Latest commit

 

History

History
168 lines (113 loc) · 5.5 KB

README.md

File metadata and controls

168 lines (113 loc) · 5.5 KB
Raw

emulation

Emulation API

  • API version: 7.0.93

Note: All Emulation APIs are not available for ThousandEyes for Government instance.

The Emulation API facilitates the retrieval of user-agent strings for HTTP, pageload, and transaction tests. It also enables the retrieval and addition of emulated devices for pageload and transaction tests.

To access Emulation API operations, the following permissions are required:

  • Settings Tests Read for read operations.
  • Settings Tests Update for write operations.

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>emulation</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:emulation:<version>"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/emulation-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.emulation.model.*;
import com.thousandeyes.sdk.emulation.EmulationApi;

public class EmulationApiExample {

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

        EmulationApi apiInstance = new EmulationApi(defaultClient);
        EmulatedDevice emulatedDevice = new EmulatedDevice(); // EmulatedDevice | 
        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 {
            EmulatedDeviceResponse result = apiInstance.createEmulatedDevice(emulatedDevice, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EmulationApi#createEmulatedDevice");
            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
EmulationApi createEmulatedDevice POST /emulated-devices Create emulated device
EmulationApi createEmulatedDeviceWithHttpInfo POST /emulated-devices Create emulated device
EmulationApi getEmulatedDevices GET /emulated-devices List emulated devices
EmulationApi getEmulatedDevicesWithHttpInfo GET /emulated-devices List emulated devices
EmulationApi getUserAgents GET /user-agents List user-agents
EmulationApi getUserAgentsWithHttpInfo GET /user-agents List user-agents

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