ThousandEyes SDK Endpoint Agents API
Project description
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.14
- 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
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.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 = 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.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.get_endpoint_agents_connection_string(aid=aid)
print("The response of AdministrativeEndpointsApi->get_endpoint_agents_connection_string:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrativeEndpointsApi->get_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 | get_endpoint_agents_connection_string | GET /v7/endpoint/agents/connection-string | Get agent connection string |
ManageAgentsApi | delete_endpoint_agent | DELETE /v7/endpoint/agents/{agentId} | Delete endpoint agent |
ManageAgentsApi | disable_endpoint_agent | POST /v7/endpoint/agents/{agentId}/disable | Disable endpoint agent |
ManageAgentsApi | enable_endpoint_agent | POST /v7/endpoint/agents/{agentId}/enable | Enable endpoint agent |
ManageAgentsApi | filter_endpoint_agents | POST /v7/endpoint/agents/filter | Filter endpoint agents |
ManageAgentsApi | get_endpoint_agent | GET /v7/endpoint/agents/{agentId} | Retrieve endpoint agent |
ManageAgentsApi | get_endpoint_agents | GET /v7/endpoint/agents | List endpoint agents |
ManageAgentsApi | update_endpoint_agent | PATCH /v7/endpoint/agents/{agentId} | Update endpoint agent |
TransferApi | transfer_endpoint_agent | POST /v7/endpoint/agents/{agentId}/transfer | Transfer endpoint agent |
TransferApi | transfer_endpoint_agents | POST /v7/endpoint/agents/transfer/bulk | Bulk transfer agents |
Documentation For Models
- AddressProfile
- AddressType
- AgentLicenseType
- AgentSearchFilters
- AgentSearchRequest
- AgentSearchSort
- AgentSearchSortKey
- AgentThresholdFilter
- AgentThresholdFilters
- AgentTransfer
- AgentTransferRequest
- AgentTransferStatus
- BrowserType
- BulkAgentTransferRequest
- BulkAgentTransferResponse
- ConditionalOperator
- ConnectionString
- EndpointAgent
- EndpointAgentLocation
- EndpointAgentUpdate
- EndpointAgents
- EndpointAsnDetails
- EndpointBrowserExtension
- EndpointClient
- EndpointUserProfile
- EndpointVpnProfile
- Error
- EthernetProfile
- Expand
- 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thousandeyes_sdk_endpoint_agents-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91a0049b95015ce505ecf15f2a50858db864ab12c2e8eff944b9eaa1bc0b02e1 |
|
MD5 | 1c77120a3e5f7ec1a56f25b5c2285338 |
|
BLAKE2b-256 | ef84a4268117dbfd9c9852a37b1f50872dda4c8abec7aa8c2613e8ddd7235774 |
Hashes for thousandeyes_sdk_endpoint_agents-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5fa750e7101d79cc3eaf4f8100314d8077440e45b4a1e75fbd51dd2fb0d3fc4 |
|
MD5 | 1697d111a6afca39b7cb002744bea3e4 |
|
BLAKE2b-256 | 56c0c658961f54ce8ba1ad6cb3fb84c082fded696cada53e34f9df465d857986 |