mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 14:36:50 +00:00

Python CI / build (push) Has been cancelled

Details

[GitHub Bot] Generated python SDK (#80 )

Co-authored-by: API Team <api-team@thousandeyes.com>

2024-10-15 10:56:27 +01:00

20 KiB

Raw Blame History

thousandeyes_sdk.endpoint_tests.AgentToServerEndpointDynamicTestsApi

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

Method	HTTP request	Description
create_agent_to_server_endpoint_dynamic_test	POST /endpoint/tests/dynamic-tests/agent-to-server	Create endpoint dynamic test
delete_agent_to_server_endpoint_dynamic_test	DELETE /endpoint/tests/dynamic-tests/agent-to-server/{testId}	Delete agent to server dynamic test
get_agent_to_server_endpoint_dynamic_test	GET /endpoint/tests/dynamic-tests/agent-to-server/{testId}	Retrieve endpoint dynamic test
get_agent_to_server_endpoint_dynamic_tests	GET /endpoint/tests/dynamic-tests/agent-to-server	List endpoint dynamic tests
update_agent_to_server_endpoint_dynamic_test	PATCH /endpoint/tests/dynamic-tests/agent-to-server/{testId}	Update agent to server dynamic test

create_agent_to_server_endpoint_dynamic_test

DynamicTest create_agent_to_server_endpoint_dynamic_test(dynamic_test_request, aid=aid)

Create endpoint dynamic test

Create a new endpoint dynamic test in ThousandEyes using properties specified in the POST data. Please note that only Account Admins have the authorization to create new tests; regular users are restricted from using POST-based methods.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.endpoint_tests
from thousandeyes_sdk.endpoint_tests.models.dynamic_test import DynamicTest
from thousandeyes_sdk.endpoint_tests.models.dynamic_test_request import DynamicTestRequest
from thousandeyes_sdk.endpoint_tests.rest 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.endpoint_tests.AgentToServerEndpointDynamicTestsApi(api_client)
    dynamic_test_request = thousandeyes_sdk.endpoint_tests.DynamicTestRequest() # DynamicTestRequest | 
    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 endpoint dynamic test
        api_response = api_instance.create_agent_to_server_endpoint_dynamic_test(dynamic_test_request, aid=aid)
        print("The response of AgentToServerEndpointDynamicTestsApi->create_agent_to_server_endpoint_dynamic_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentToServerEndpointDynamicTestsApi->create_agent_to_server_endpoint_dynamic_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
dynamic_test_request	DynamicTestRequest
aid	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]

Return type

DynamicTest

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
201	Created	* Location -
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_agent_to_server_endpoint_dynamic_test

delete_agent_to_server_endpoint_dynamic_test(test_id, aid=aid)

Delete agent to server dynamic test

Deletes an agent to server endpoint dynamic test.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.endpoint_tests
from thousandeyes_sdk.endpoint_tests.rest 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.endpoint_tests.AgentToServerEndpointDynamicTestsApi(api_client)
    test_id = '584739201' # str | Unique ID of endpoint test.
    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:
        # Delete agent to server dynamic test
        api_instance.delete_agent_to_server_endpoint_dynamic_test(test_id, aid=aid)
    except Exception as e:
        print("Exception when calling AgentToServerEndpointDynamicTestsApi->delete_agent_to_server_endpoint_dynamic_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Unique ID of endpoint test.
aid	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]

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
204	No content	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent_to_server_endpoint_dynamic_test

DynamicTest get_agent_to_server_endpoint_dynamic_test(test_id, aid=aid)

Retrieve endpoint dynamic test

Returns details of an endpoint dynamic test, including test type, name, intervals, targets.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.endpoint_tests
from thousandeyes_sdk.endpoint_tests.models.dynamic_test import DynamicTest
from thousandeyes_sdk.endpoint_tests.rest 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.endpoint_tests.AgentToServerEndpointDynamicTestsApi(api_client)
    test_id = '584739201' # str | Unique ID of endpoint test.
    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:
        # Retrieve endpoint dynamic test
        api_response = api_instance.get_agent_to_server_endpoint_dynamic_test(test_id, aid=aid)
        print("The response of AgentToServerEndpointDynamicTestsApi->get_agent_to_server_endpoint_dynamic_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentToServerEndpointDynamicTestsApi->get_agent_to_server_endpoint_dynamic_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Unique ID of endpoint test.
aid	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]

Return type

DynamicTest

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_agent_to_server_endpoint_dynamic_tests

DynamicTests get_agent_to_server_endpoint_dynamic_tests(aid=aid)

List endpoint dynamic tests

Returns a list of all endpoint dynamic tests configured in ThousandEyes. This list does not contain saved events.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.endpoint_tests
from thousandeyes_sdk.endpoint_tests.models.dynamic_tests import DynamicTests
from thousandeyes_sdk.endpoint_tests.rest 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.endpoint_tests.AgentToServerEndpointDynamicTestsApi(api_client)
    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:
        # List endpoint dynamic tests
        api_response = api_instance.get_agent_to_server_endpoint_dynamic_tests(aid=aid)
        print("The response of AgentToServerEndpointDynamicTestsApi->get_agent_to_server_endpoint_dynamic_tests:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentToServerEndpointDynamicTestsApi->get_agent_to_server_endpoint_dynamic_tests: %s\n" % e)

Parameters

Name	Type	Description	Notes
aid	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]

Return type

DynamicTests

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_agent_to_server_endpoint_dynamic_test

DynamicTest update_agent_to_server_endpoint_dynamic_test(test_id, endpoint_dynamic_test_update, aid=aid)

Update agent to server dynamic test

Updates an agent to server endpoint dynamic test. Includes support for enabling and disabling the test.

Example

Bearer Authentication (BearerAuth):

import thousandeyes_sdk.endpoint_tests
from thousandeyes_sdk.endpoint_tests.models.dynamic_test import DynamicTest
from thousandeyes_sdk.endpoint_tests.models.endpoint_dynamic_test_update import EndpointDynamicTestUpdate
from thousandeyes_sdk.endpoint_tests.rest 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.endpoint_tests.AgentToServerEndpointDynamicTestsApi(api_client)
    test_id = '584739201' # str | Unique ID of endpoint test.
    endpoint_dynamic_test_update = thousandeyes_sdk.endpoint_tests.EndpointDynamicTestUpdate() # EndpointDynamicTestUpdate | 
    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:
        # Update agent to server dynamic test
        api_response = api_instance.update_agent_to_server_endpoint_dynamic_test(test_id, endpoint_dynamic_test_update, aid=aid)
        print("The response of AgentToServerEndpointDynamicTestsApi->update_agent_to_server_endpoint_dynamic_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentToServerEndpointDynamicTestsApi->update_agent_to_server_endpoint_dynamic_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Unique ID of endpoint test.
endpoint_dynamic_test_update	EndpointDynamicTestUpdate
aid	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]

Return type

DynamicTest

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

20 KiB Raw Blame History

thousandeyes_sdk.endpoint_tests.AgentToServerEndpointDynamicTestsApi

create_agent_to_server_endpoint_dynamic_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_agent_to_server_endpoint_dynamic_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent_to_server_endpoint_dynamic_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_agent_to_server_endpoint_dynamic_tests

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_agent_to_server_endpoint_dynamic_test

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

20 KiB

Raw Blame History