thousandeyes-sdk-python/thousandeyes-sdk-endpoint-agents

thousandeyes-sdk-endpoint-agents

Note: The Endpoint Agents Transfer APIs are not available for ThousandEyes for Government instance.

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.97
• Generator version: 7.6.0
• Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.9+

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.EndpointAgentLogItemsApi(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)
    max = 1000 # int | Maximum number of log items returned per page. (optional) (default to 1000)
    cursor = 'WyIxNzA5MjQwMDAwMDAwIl0=' # str | Opaque cursor from the `_links.next.href` URL in the previous response. (optional)
    window = '12h' # str | A dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: `s` for seconds (default if no type is specified), `m` for minutes, `h` for hours, `d` for days, and `w` for weeks. For a precise date range, use `startDate` and `endDate`. (optional)
    start_date = '2022-07-17T22:00:54Z' # datetime | Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
    end_date = '2022-07-18T22:00:54Z' # datetime | Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)

    try:
        # List endpoint agent log items
        api_response = api_instance.get_endpoint_agent_log_items(agent_id, aid=aid, max=max, cursor=cursor, window=window, start_date=start_date, end_date=end_date)
        print("The response of EndpointAgentLogItemsApi->get_endpoint_agent_log_items:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EndpointAgentLogItemsApi->get_endpoint_agent_log_items: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
EndpointAgentLogItemsApi	get_endpoint_agent_log_items	GET /endpoint/agents/{agentId}/logs	List endpoint agent log items
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
EndpointProxiesApi	get_endpoint_proxies	GET /endpoint/proxies	List endpoint proxy settings

Documentation For Models

• AddressProfile
• AddressType
• AgentLicenseType
• AgentSearchFilters
• AgentSearchRequest
• AgentSearchSort
• AgentSearchSortKey
• AgentThresholdFilter
• AgentThresholdFilters
• AgentTransfer
• AgentTransferRequest
• AgentTransferStatus
• BatteryLevel
• BatteryMetrics
• BrowserType
• BulkAgentTransferRequest
• BulkAgentTransferResponse
• CellularProfile
• ConditionalOperator
• ConnectionString
• EndpointAgent
• EndpointAgentEthernetProfile
• EndpointAgentLocation
• EndpointAgentLogItem
• EndpointAgentLogItemType
• EndpointAgentLogItemsResponse
• EndpointAgentUpdate
• EndpointAgents
• EndpointAsnDetails
• EndpointBrowserExtension
• EndpointClient
• EndpointOnlineOfflineLogItem
• EndpointOnlineOfflineLogItemType
• EndpointProxiesResponse
• EndpointProxy
• EndpointProxyAuthType
• EndpointProxyType
• EndpointStateChangesLogItem
• EndpointStateChangesLogItemType
• EndpointUserProfile
• EndpointVpnLogItem
• EndpointVpnLogItemType
• EndpointVpnProfile
• EndpointVpnType
• EndpointWifiLogItem
• EndpointWifiLogItemType
• EndpointWirelessConnectionFailure
• EndpointWirelessConnectionFailureType
• Error
• ExpandEndpointAgentOptions
• ExternalMetadataItem
• FilterEndpointAgentsResponse
• InterfaceHardwareType
• InterfaceProfile
• Link
• ListEndpointAgentsResponse
• PaginationNextAndSelfLink
• PaginationNextLink
• Platform
• SelfLinks
• SortOrder
• Status
• ThresholdFilterOperator
• UnauthorizedError
• ValidationError
• ValidationErrorItem
• VpnType
• WirelessProfile

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team