Get Take Control URL: get_take_control_connection_url

Service name: get_take_control_connection_url

URL

https://SERVER/api/?apikey=yourAPItoken&service=get_take_control_connection_url

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Returns a Take Control connection URL for Take Control (TeamViewer) or Take Control (SolarWinds) (From Agent 10.5)

 

Example Service Call =get_take_control_connection_url

https://SERVER/api/?apikey=yourAPItoken&service=get_take_control_connection_url&deviceid=DEVICEID

Example Response (from Agent 10.5)

 
<?xml version="1.0" encoding="ISO-8859-1"?>
<result created=""2016-08-24T12:55:30+01:00"" host=""SERVER"" status=""OK"">
connection>takectrsxvp://a9026C01e03B5a6f9F62be85686d789eRda5dd6f051ca74960ec199973cf8bf0f76423d8352=</connection>
</result>

Example Response (pre-Agent 10.5

 
<?xml version="1.0" encoding="ISO-8859-1"?>
<result created="2016-08-30T13:00:49+01:00" host="hdog1" status="OK">
    <connection>https://SERVER/api/takecontrol/tvc/ZY9Bb4IwAEbv-IrdjZFqC%2BzAQWHKQEUHA43ZoUKhSKFaCkyX-fexs9cv...</connection>
</result>

 

Field Description

Field

Type

Can Be Empty

Description

connection

string

no

Take Control connection URL for a new session

 

Example Associated Service Calls
Parameter Call URL Format
DeviceID list_devices_at_client

https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
list_servers

https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID

list_workstations

https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID
SiteID list_sites https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID
ClientID list_clients https://SERVER/api/?apikey=yourAPItoken&service=list_clients

Take Control from Agent 10.5

takectrsxvp must be associated with the Take Control Viewer before a connection can be established using the URL. This association may be achieved by logging on to the Dashboard, initiating a session to a remote device and choosing the option to Remember my choice for takectrsxvp links (or equivalent).

User Audit Report

get_take_control_connection_url API call automatically generates an entry in the User Audit Report against the Agent Key for the account.

Action

Date/Time

Details

Username

[Added]

25 Mar 2015 10:49:54

Take Control Session: Client: Demo Client, Site: Demo Site, Device: USDEMOSERVER

agent_key@login.it

Where do you want to go now?