thousandeyes-sdk-emulation 2.1.0

ThousandEyes SDK Emulation API

thousandeyes-sdk-emulation

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.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.28
• Generator version: 7.6.0
• Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.8+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-emulation

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-emulation)

Then import the package:

import thousandeyes_sdk.emulation

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import thousandeyes_sdk.emulation

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.emulation
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com/v7"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.emulation.EmulationApi(api_client)
    emulated_device = thousandeyes_sdk.emulation.EmulatedDevice() # EmulatedDevice | 
    aid = '1234' # str | 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. (optional)

    try:
        # Create emulated device
        api_response = api_instance.create_emulated_device(emulated_device, aid=aid)
        print("The response of EmulationApi->create_emulated_device:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EmulationApi->create_emulated_device: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
EmulationApi	create_emulated_device	POST /emulated-devices	Create emulated device
EmulationApi	get_emulated_devices	GET /emulated-devices	List emulated devices
EmulationApi	get_user_agents	GET /user-agents	List user-agents

Documentation For Models

• EmulatedDevice
• EmulatedDeviceCategory
• EmulatedDeviceResponse
• EmulatedDeviceResponses
• Error
• ExpandEmulatedDeviceOptions
• Link
• SelfLinks
• UnauthorizedError
• UserAgent
• UserAgents

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team