thousandeyes-sdk-python/endpoint_agents

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.2
• Package version: 1.0.0
• Generator version: 7.5.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:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import endpoint_agents
from endpoint_agents.rest 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 = endpoint_agents.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 = endpoint_agents.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with endpoint_agents.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = endpoint_agents.AdministrativeEndpointsApi(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:
        # Get agent connection string
        api_response = api_instance.endpoint_agents_connection_string(aid=aid)
        print("The response of AdministrativeEndpointsApi->endpoint_agents_connection_string:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdministrativeEndpointsApi->endpoint_agents_connection_string: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AdministrativeEndpointsApi	endpoint_agents_connection_string	GET /v7/endpoint/agents/connection-string	Get agent connection string
ManageAgentsApi	endpoint_agent_delete	DELETE /v7/endpoint/agents/{agentId}	Delete endpoint agent
ManageAgentsApi	endpoint_agent_disable	POST /v7/endpoint/agents/{agentId}/disable	Disable endpoint agent
ManageAgentsApi	endpoint_agent_enable	POST /v7/endpoint/agents/{agentId}/enable	Enable endpoint agent
ManageAgentsApi	endpoint_agent_get	GET /v7/endpoint/agents/{agentId}	Retrieve endpoint agent
ManageAgentsApi	endpoint_agent_update	PATCH /v7/endpoint/agents/{agentId}	Update endpoint agent
ManageAgentsApi	endpoint_agents_list	GET /v7/endpoint/agents	List endpoint agents
ManageAgentsApi	endpoint_agents_search	POST /v7/endpoint/agents/filter	Filter endpoint agents
TransferApi	endpoint_agent_bulk_transfer	POST /v7/endpoint/agents/transfer/bulk	Bulk transfer agents
TransferApi	endpoint_agent_single_transfer	POST /v7/endpoint/agents/{agentId}/transfer	Transfer endpoint agent

Documentation For Models

• AddressProfile
• AddressType
• AgentLicenseType
• AgentSearchRequest
• AgentSearchRequestSearchFilters
• AgentSearchSort
• AgentSearchSortKey
• AgentThresholdFilter
• AgentThresholdFilters
• AgentTransfer
• AgentTransferRequest
• BrowserType
• ConditionalOperator
• EndpointAgent
• EndpointAgentBulkTransfer207Response
• EndpointAgentBulkTransfer207ResponseItemsInner
• EndpointAgentBulkTransferRequest
• EndpointAgentGet200Response
• EndpointAgentLocation
• EndpointAgentUpdate
• EndpointAgents
• EndpointAgentsAgentsInner
• EndpointAgentsConnectionString200Response
• EndpointAgentsList200Response
• EndpointAgentsSearch200Response
• EndpointAsnDetails
• EndpointBrowserExtension
• EndpointClient
• EndpointUserProfile
• EndpointVpnProfile
• Error
• EthernetProfile
• Expand
• InterfaceHardwareType
• InterfaceProfile
• Link
• PaginationNextAndSelfLink
• PaginationNextAndSelfLinkLinks
• PaginationNextLink
• PaginationNextLinkLinks
• Platform
• SelfLinks
• SelfLinksLinks
• SortOrder
• Status
• ThresholdFilterOperator
• UnauthorizedError
• ValidationError
• ValidationErrorAllOfErrors
• VpnType
• WirelessProfile

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author