thousandeyes-sdk-python/endpoint_agents/docs/TransferApi.md

endpoint_agents.TransferApi

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

Method	HTTP request	Description
endpoint_agent_bulk_transfer	POST /v7/endpoint/agents/transfer/bulk	Bulk transfer agents
endpoint_agent_single_transfer	POST /v7/endpoint/agents/{agentId}/transfer	Transfer endpoint agent

endpoint_agent_bulk_transfer

EndpointAgentBulkTransfer207Response endpoint_agent_bulk_transfer(aid=aid, endpoint_agent_bulk_transfer_request=endpoint_agent_bulk_transfer_request)

Bulk transfer agents

Initiates the transfer of multiple agents between accounts. The following conditions apply: * The requester must possess 'write' permissions for both the 'from' and 'to' accounts involved in each transfer. * Multiple transfers may involve a mix of different source and destination accounts. * For each transfer request, the 'from' account must match the current account of the respective agent. * Transfers are executed asynchronously. * Progress tracking is not intended, but users can monitor the progress by periodically polling the 'get agent' endpoint. * Each transfer request is individually validated and completed; this operation is not atomic, meaning transfers can succeed or fail individually. * The API response provides the status of each transfer request.

Example

• Bearer Authentication (BearerAuth):

import endpoint_agents
from endpoint_agents.models.endpoint_agent_bulk_transfer207_response import EndpointAgentBulkTransfer207Response
from endpoint_agents.models.endpoint_agent_bulk_transfer_request import EndpointAgentBulkTransferRequest
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.TransferApi(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)
    endpoint_agent_bulk_transfer_request = endpoint_agents.EndpointAgentBulkTransferRequest() # EndpointAgentBulkTransferRequest | A collection of `AgentTransfers`. (optional)

    try:
        # Bulk transfer agents
        api_response = api_instance.endpoint_agent_bulk_transfer(aid=aid, endpoint_agent_bulk_transfer_request=endpoint_agent_bulk_transfer_request)
        print("The response of TransferApi->endpoint_agent_bulk_transfer:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TransferApi->endpoint_agent_bulk_transfer: %s\n" % e)

Parameters

Name	Type	Description	Notes
aid	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]
endpoint_agent_bulk_transfer_request	EndpointAgentBulkTransferRequest	A collection of `AgentTransfers`.	[optional]

Return type

EndpointAgentBulkTransfer207Response

Authorization

BearerAuth

HTTP request headers

• Content-Type: application/json, text/csv, text/plain
• Accept: application/hal+json, application/problem+json

HTTP response details

Status code	Description	Response headers
207	Transfer initiated	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

endpoint_agent_single_transfer

endpoint_agent_single_transfer(agent_id, agent_transfer_request, aid=aid)

Transfer endpoint agent

Initiates the transfer of an agent from its current account, which must correspond to the provided aid, to the target account. Note: It is essential to ensure that the aid parameter matches the current account of the agent for this operation to succeed.

Example

• Bearer Authentication (BearerAuth):

import endpoint_agents
from endpoint_agents.models.agent_transfer_request import AgentTransferRequest
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.TransferApi(api_client)
    agent_id = 'agent_id_example' # str | The identifier of the agent to operate on.
    agent_transfer_request = endpoint_agents.AgentTransferRequest() # AgentTransferRequest | The request to move an agent between accounts.
    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:
        # Transfer endpoint agent
        api_instance.endpoint_agent_single_transfer(agent_id, agent_transfer_request, aid=aid)
    except Exception as e:
        print("Exception when calling TransferApi->endpoint_agent_single_transfer: %s\n" % e)

Parameters

Name	Type	Description	Notes
agent_id	str	The identifier of the agent to operate on.
agent_transfer_request	AgentTransferRequest	The request to move an agent between accounts.
aid	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]

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/problem+json

HTTP response details

Status code	Description	Response headers
202	Transfer initiated	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]