ThousandEyes SDK Test Snapshots API
Project description
thousandeyes-sdk-snapshots
Creates a new test snapshot in ThousandEyes.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 7.0.22
- 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-snapshots
(you may need to run pip
with root permission: sudo pip install thousandeyes-sdk-snapshots
)
Then import the package:
import thousandeyes_sdk.snapshots
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.snapshots
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.snapshots
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.snapshots.TestSnapshotsApi(api_client)
test_id = '202701' # str | Test ID
snapshot_request = thousandeyes_sdk.snapshots.SnapshotRequest() # SnapshotRequest |
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 test snapshot
api_response = api_instance.create_test_snapshot(test_id, snapshot_request, aid=aid)
print("The response of TestSnapshotsApi->create_test_snapshot:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling TestSnapshotsApi->create_test_snapshot: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com/v7
Class | Method | HTTP request | Description |
---|---|---|---|
TestSnapshotsApi | create_test_snapshot | POST /tests/{testId}/snapshot | Create test snapshot |
Documentation For Models
- AppAndSelfLinks
- Error
- Link
- SnapshotLinks
- SnapshotRequest
- SnapshotResponse
- SnapshotTest
- TestInterval
- TestLinks
- TestSelfLink
- TestType
- UnauthorizedError
- UnexpandedInstantTest
- UnexpandedTest
- ValidationError
- ValidationErrorItem
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thousandeyes_sdk_snapshots-2.0.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a67c35e200ed7dbfd46cf0f3b8361ca00a0bfd633b474d1e5804f57f4957f22a |
|
MD5 | f698de9e4ac03077d7e5a50b3a9aa269 |
|
BLAKE2b-256 | a26d8a56c93aae0a024d08bac0faf8bc483f28bb08c93194634408e6f664d2fc |
Hashes for thousandeyes_sdk_snapshots-2.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e57ce345cff5472435dc5c1826badaa3ab5dc962d52746abdb4a9ebbaae54e42 |
|
MD5 | 45c86a04bec7e1282f9a8fc7ffc6fd8f |
|
BLAKE2b-256 | 6196a8f5c8d5971f0515d4177ea2e8bb56d54c90a1c8af02e0e6a7d56b697001 |