thousandeyes-sdk-python/snapshots_api/README.md

snapshots-api

Creates a new test snapshot in ThousandEyes

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

• API version: 7.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git)

Then import the package:

import snapshots_api

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 snapshots_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import snapshots_api
from snapshots_api.rest import ApiException
from pprint import pprint

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

# 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 = snapshots_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with snapshots_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = snapshots_api.CreateTestSnapshotApi(api_client)
    test_id = '281474976710706' # str | Test ID.
    snapshot_request = snapshots_api.SnapshotRequest() # SnapshotRequest | 
    aid = '2067' # 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 test snapshot
        api_response = api_instance.create_test_snapshot(test_id, snapshot_request, aid=aid)
        print("The response of CreateTestSnapshotApi->create_test_snapshot:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CreateTestSnapshotApi->create_test_snapshot: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
CreateTestSnapshotApi	create_test_snapshot	POST /v7/tests/{testId}/snapshot	Create test snapshot

Documentation For Models

• AppLinks
• AppLinksLinks
• Error
• Link
• SelfLinks
• SelfLinksLinks
• SnapshotLinks
• SnapshotRequest
• SnapshotResponse
• SnapshotResponseAllOfTest
• TestInterval
• TestType
• UnauthorizedError
• UnexpandedInstantTest
• UnexpandedInstantTestLinks
• UnexpandedInstantTestLinksSelf
• UnexpandedInstantTestLinksTestResults
• UnexpandedTest

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author