Create Remote Agent

Description

The endpoint Create Remote Agent is used to create an Agent of Remote Agent type in Leapwork. After the successful creation of a Remote Agent, the Id of the agent is returned in the response.

The details of the created agent can be validated with the help of the Get Agent by Id endpoint.

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/agents/create/remoteagent

Input parameters

Examples

Curl

curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' -d '{ \
"Port": "6777", \
"Title": "My Remote Agent Environment", \
"Description": "Remote Agent", \
"HostName": "192.168.1.100", \
"Password": "" \,                                                                                                                          "AuthenticationType": "windowsLogin",\
"Password": "string",\
"WindowsLogin": "string",\
"WindowsPassword": "string",\
"LockSessionAfterDisconnect": true\
}' 'http://{controllerMachine}:{controllerPort}/api/v4/agents/create/remoteagent'

PowerShell 

$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")

$requestBody = @'
{
    "Port": "6777",
    "Title": "My Remote Agent",
    "Description": "Remote Agent",
    "HostName": "192.168.1.100",
    "Password": "",                                                                                                                                                          "AuthenticationType": "windowsLogin",
    "Password": "string",
    "WindowsLogin": "string",
    "WindowsPassword": "string",
    "LockSessionAfterDisconnect": true
}
'@ 

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/agents/create/remoteagent" -ContentType "application/json" -Headers $headers -Method PUT  -Body $requestBody

Response Body

CreateAgentResponse object:

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)