thousandeyes-sdk-python/thousandeyes-sdk-endpoint-instant-tests/README.md

# thousandeyes-sdk-endpoint-instant-tests

You can create and execute a new endpoint instant scheduled test within ThousandEyes using this API. The test parameters are specified in the `POST` data.

The following applies to the Endpoint Instant Scheduled Tests API:

* To initiate the creation and execution of an instant scheduled test, the user must possess the `Edit endpoint tests` permission.

* Upon successful creation of an instant scheduled test, the API responds with an HTTP/201 CREATED status code and return the test definition.
* It's important to note that the response does not include the results of the instant scheduled test. To retrieve test results, users can utilize the Endpoint Test Data endpoints.
The URLs for these API test data endpoints are provided within the test definition output when an instant scheduled test is created.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.0.8
- Generator version: 7.6.0
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

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

```sh
pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-endpoint-instant-tests\&subdirectory=thousandeyes-sdk-endpoint-instant-tests
```
(you may need to run `pip` with root permission: `sudo pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-endpoint-instant-tests\&subdirectory=thousandeyes-sdk-endpoint-instant-tests`)

Then import the package:
```python
import thousandeyes_sdk.endpoint_instant_tests
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import thousandeyes_sdk.endpoint_instant_tests
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import thousandeyes_sdk.core
import thousandeyes_sdk.endpoint_instant_tests
from thousandeyes_sdk.core.exceptions 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 = thousandeyes_sdk.core.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 = 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.endpoint_instant_tests.AgentToServerInstantScheduledTestApi(api_client)
    endpoint_agent_to_server_instant_test = thousandeyes_sdk.endpoint_instant_tests.EndpointAgentToServerInstantTest() # EndpointAgentToServerInstantTest | 
    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:
        # Run agent to server instant scheduled test
        api_response = api_instance.create_agent_to_server_scheduled_instant_test(endpoint_agent_to_server_instant_test, aid=aid)
        print("The response of AgentToServerInstantScheduledTestApi->create_agent_to_server_scheduled_instant_test:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentToServerInstantScheduledTestApi->create_agent_to_server_scheduled_instant_test: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AgentToServerInstantScheduledTestApi* | [**create_agent_to_server_scheduled_instant_test**](docs/AgentToServerInstantScheduledTestApi.md#create_agent_to_server_scheduled_instant_test) | **POST** /v7/endpoint/tests/scheduled-tests/agent-to-server/instant | Run agent to server instant scheduled test
*HttpServerInstantScheduledTestApi* | [**create_http_server_scheduled_instant_test**](docs/HttpServerInstantScheduledTestApi.md#create_http_server_scheduled_instant_test) | **POST** /v7/endpoint/tests/scheduled-tests/http-server/instant | Run http server instant scheduled test
*RunExistingTestApi* | [**run_endpoint_scheduled_instant_test**](docs/RunExistingTestApi.md#run_endpoint_scheduled_instant_test) | **POST** /v7/endpoint/tests/scheduled-tests/{testId}/run | Run endpoint instant scheduled test


## Documentation For Models

 - [AlertDirection](docs/AlertDirection.md)
 - [AlertRoundsViolationMode](docs/AlertRoundsViolationMode.md)
 - [AlertRule](docs/AlertRule.md)
 - [AlertType](docs/AlertType.md)
 - [EndpointAgentLabelsSelectorConfig](docs/EndpointAgentLabelsSelectorConfig.md)
 - [EndpointAgentSelectorConfig](docs/EndpointAgentSelectorConfig.md)
 - [EndpointAgentToServerInstantTest](docs/EndpointAgentToServerInstantTest.md)
 - [EndpointAgentToServerTest](docs/EndpointAgentToServerTest.md)
 - [EndpointAllAgentsSelectorConfig](docs/EndpointAllAgentsSelectorConfig.md)
 - [EndpointHttpServerBaseTest](docs/EndpointHttpServerBaseTest.md)
 - [EndpointHttpServerInstantTest](docs/EndpointHttpServerInstantTest.md)
 - [EndpointHttpServerTest](docs/EndpointHttpServerTest.md)
 - [EndpointInstantTest](docs/EndpointInstantTest.md)
 - [EndpointScheduledTestType](docs/EndpointScheduledTestType.md)
 - [EndpointSpecificAgentsSelectorConfig](docs/EndpointSpecificAgentsSelectorConfig.md)
 - [EndpointTest](docs/EndpointTest.md)
 - [EndpointTestAgentSelectorType](docs/EndpointTestAgentSelectorType.md)
 - [EndpointTestAuthType](docs/EndpointTestAuthType.md)
 - [EndpointTestLinks](docs/EndpointTestLinks.md)
 - [EndpointTestProtocol](docs/EndpointTestProtocol.md)
 - [EndpointTestSelfLink](docs/EndpointTestSelfLink.md)
 - [Error](docs/Error.md)
 - [Link](docs/Link.md)
 - [Severity](docs/Severity.md)
 - [TestInterval](docs/TestInterval.md)
 - [TestLabel](docs/TestLabel.md)
 - [TestProbeModeResponse](docs/TestProbeModeResponse.md)
 - [TestSslVersionId](docs/TestSslVersionId.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorItem](docs/ValidationErrorItem.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author