gitea-admin/thousandeyes-sdk-python
1
0
Fork 0
mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 06:26:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a4d9d6a0ed
thousandeyes-sdk-python/agents/README.md

8.0 KiB
Raw Blame History

agents

Overview

Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise 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 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 agents

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


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


# Enter a context with an instance of the API client
with agents.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agents.CloudAndEnterpriseAgentNotificationRulesApi(api_client)
    notification_rule_id = '281474976710706' # str | Unique ID for the agent notification rule.
    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:
        # Retrieve agent notification rule
        api_response = api_instance.get_agents_notification_rule(notification_rule_id, aid=aid)
        print("The response of CloudAndEnterpriseAgentNotificationRulesApi->get_agents_notification_rule:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CloudAndEnterpriseAgentNotificationRulesApi->get_agents_notification_rule: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
CloudAndEnterpriseAgentNotificationRulesApi get_agents_notification_rule GET /v7/agents/notification-rules/{notificationRuleId} Retrieve agent notification rule
CloudAndEnterpriseAgentNotificationRulesApi get_agents_notification_rules GET /v7/agents/notification-rules List agent notification rules
CloudAndEnterpriseAgentsApi delete_enterprise_agent DELETE /v7/agents/{agentId} Delete Enterprise Agent
CloudAndEnterpriseAgentsApi get_agent_details GET /v7/agents/{agentId} Retrieve Cloud and Enterprise Agent
CloudAndEnterpriseAgentsApi get_agents GET /v7/agents List Cloud and Enterprise Agents
CloudAndEnterpriseAgentsApi update_enterprise_agent_details PUT /v7/agents/{agentId} Update Enterprise Agent
EnterpriseAgentClusterApi assign_enterprise_agent_cluster POST /v7/agents/{agentId}/cluster/assign Add member to Enterprise Agent cluster
EnterpriseAgentClusterApi unassign_enterprise_agent_from_cluster POST /v7/agents/{agentId}/cluster/unassign Remove member from Enterprise Agent cluster
ProxiesApi get_agent_proxies GET /v7/agents/proxies List agent proxies

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author