Skip to content

Latest commit

 

History

History
176 lines (134 loc) · 13.5 KB

README.md

File metadata and controls

176 lines (134 loc) · 13.5 KB
Raw

thousandeyes-sdk-endpoint-agents

Manage ThousandEyes Endpoint Agents using this API.

For more information about Endpoint Agents, see Endpoint Agents.

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

  • API version: 7.0.25
  • 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-endpoint-agents

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-endpoint-agents)

Then import the package:

import thousandeyes_sdk.endpoint_agents

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.endpoint_agents

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.endpoint_agents
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.endpoint_agents.EndpointAgentsApi(api_client)
    agent_id = 'agent_id_example' # str | The identifier of the agent to operate on.
    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.endpoint_agents.ExpandEndpointAgentOptions()] # List[ExpandEndpointAgentOptions] | This optional parameter allows you to control the expansion of test resources associated with the agent. By default, no expansion occurs when this query parameter is omitted. To expand the \"clients\" resource, include the query parameter `?expand=clients`.  For multiple expansions, you have two options:    * Separate the values with commas. For example, `?expandAgent=clients,tasks`. * Specify the parameter multiple times. For example, `?expandAgent=clients&expandAgent=tasks`.  This parameter offers flexibility for users to customize the expansion of specific resources related to the agent.  (optional)

    try:
        # Delete endpoint agent
        api_instance.delete_endpoint_agent(agent_id, aid=aid, expand=expand)
    except ApiException as e:
        print("Exception when calling EndpointAgentsApi->delete_endpoint_agent: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
EndpointAgentsApi delete_endpoint_agent DELETE /endpoint/agents/{agentId} Delete endpoint agent
EndpointAgentsApi disable_endpoint_agent POST /endpoint/agents/{agentId}/disable Disable endpoint agent
EndpointAgentsApi enable_endpoint_agent POST /endpoint/agents/{agentId}/enable Enable endpoint agent
EndpointAgentsApi filter_endpoint_agents POST /endpoint/agents/filter Filter endpoint agents
EndpointAgentsApi get_endpoint_agent GET /endpoint/agents/{agentId} Retrieve endpoint agent
EndpointAgentsApi get_endpoint_agents GET /endpoint/agents List endpoint agents
EndpointAgentsApi get_endpoint_agents_connection_string GET /endpoint/agents/connection-string Get agent connection string
EndpointAgentsApi update_endpoint_agent PATCH /endpoint/agents/{agentId} Update endpoint agent
EndpointAgentsTransferApi transfer_endpoint_agent POST /endpoint/agents/{agentId}/transfer Transfer endpoint agent
EndpointAgentsTransferApi transfer_endpoint_agents POST /endpoint/agents/transfer/bulk Bulk transfer agents

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author

ThousandEyes API Team