gitea-admin/thousandeyes-sdk-python
1
0
Fork 0
mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 07:55:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
92b9a0126c
thousandeyes-sdk-python/thousandeyes-sdk-endpoint-agents/README.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5) 
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

7.4 KiB
Raw Blame History

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.4
  • Package version: 1.0.0
  • Generator version: 7.6.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 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.client
import thousandeyes_sdk.endpoint_agents
from thousandeyes_sdk.client.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.client.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.client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.client.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.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

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author