thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/SIPServerTestsApi.md

thousandeyes_sdk.tests.SIPServerTestsApi

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

Method	HTTP request	Description
create_sip_server_test	POST /tests/sip-server	Create SIP Server test
delete_sip_server_test	DELETE /tests/sip-server/{testId}	Delete SIP Server test
get_sip_server_test	GET /tests/sip-server/{testId}	Get SIP Server test
get_sip_server_tests	GET /tests/sip-server	List SIP Server tests
update_sip_server_test	PUT /tests/sip-server/{testId}	Update SIP Server test

create_sip_server_test

SipServerTestResponse create_sip_server_test(sip_server_test_request, aid=aid, expand=expand)

Create SIP Server test

Creates a new SIP Server test. This method requires Account Admin permissions.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.expand_test_options import ExpandTestOptions
from thousandeyes_sdk.tests.models.sip_server_test_request import SipServerTestRequest
from thousandeyes_sdk.tests.models.sip_server_test_response import SipServerTestResponse
from thousandeyes_sdk.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.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.SIPServerTestsApi(api_client)
    sip_server_test_request = thousandeyes_sdk.tests.SipServerTestRequest() # SipServerTestRequest | 
    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)
    expand = [thousandeyes_sdk.tests.ExpandTestOptions()] # List[ExpandTestOptions] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

    try:
        # Create SIP Server test
        api_response = api_instance.create_sip_server_test(sip_server_test_request, aid=aid, expand=expand)
        print("The response of SIPServerTestsApi->create_sip_server_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIPServerTestsApi->create_sip_server_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
sip_server_test_request	SipServerTestRequest
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]
expand	**List[ExpandTestOptions]**	Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.	[optional]

Return type

SipServerTestResponse

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_sip_server_test

delete_sip_server_test(test_id, aid=aid)

Delete SIP Server test

Deletes the specified SIP Server test. This method requires Account Admin permissions.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.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.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.SIPServerTestsApi(api_client)
    test_id = '202701' # str | Test ID
    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 SIP Server test
        api_instance.delete_sip_server_test(test_id, aid=aid)
    except Exception as e:
        print("Exception when calling SIPServerTestsApi->delete_sip_server_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Test ID
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	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

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

get_sip_server_test

SipServerTestResponse get_sip_server_test(test_id, aid=aid, expand=expand)

Get SIP Server test

Returns details for a SIP Server test, including name, intervals, targets, alert rules and agents.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.expand_test_options import ExpandTestOptions
from thousandeyes_sdk.tests.models.sip_server_test_response import SipServerTestResponse
from thousandeyes_sdk.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.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.SIPServerTestsApi(api_client)
    test_id = '202701' # str | Test ID
    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)
    expand = [thousandeyes_sdk.tests.ExpandTestOptions()] # List[ExpandTestOptions] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

    try:
        # Get SIP Server test
        api_response = api_instance.get_sip_server_test(test_id, aid=aid, expand=expand)
        print("The response of SIPServerTestsApi->get_sip_server_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIPServerTestsApi->get_sip_server_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Test ID
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]
expand	**List[ExpandTestOptions]**	Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.	[optional]

Return type

SipServerTestResponse

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_sip_server_tests

SipServerTests get_sip_server_tests(aid=aid)

List SIP Server tests

Returns a list of SIP Server tests and saved events.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.sip_server_tests import SipServerTests
from thousandeyes_sdk.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.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.SIPServerTestsApi(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 SIP Server tests
        api_response = api_instance.get_sip_server_tests(aid=aid)
        print("The response of SIPServerTestsApi->get_sip_server_tests:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIPServerTestsApi->get_sip_server_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

SipServerTests

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]

update_sip_server_test

SipServerTestResponse update_sip_server_test(test_id, sip_server_test_request, aid=aid, expand=expand)

Update SIP Server test

Updates a SIP Server test. The target test cannot be a live share or saved event. This method requires Account Admin permissions.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.tests
from thousandeyes_sdk.tests.models.expand_test_options import ExpandTestOptions
from thousandeyes_sdk.tests.models.sip_server_test_request import SipServerTestRequest
from thousandeyes_sdk.tests.models.sip_server_test_response import SipServerTestResponse
from thousandeyes_sdk.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.tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.tests.SIPServerTestsApi(api_client)
    test_id = '202701' # str | Test ID
    sip_server_test_request = thousandeyes_sdk.tests.SipServerTestRequest() # SipServerTestRequest | 
    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)
    expand = [thousandeyes_sdk.tests.ExpandTestOptions()] # List[ExpandTestOptions] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

    try:
        # Update SIP Server test
        api_response = api_instance.update_sip_server_test(test_id, sip_server_test_request, aid=aid, expand=expand)
        print("The response of SIPServerTestsApi->update_sip_server_test:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SIPServerTestsApi->update_sip_server_test: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Test ID
sip_server_test_request	SipServerTestRequest
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]
expand	**List[ExpandTestOptions]**	Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query.	[optional]

Return type

SipServerTestResponse

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]