Create Browser Stack

Description

The endpoint Create Browser Stack is used to create an Agent of Browser Stack type in LEAPWORK. After the successful creation of a Browser Stack Agent, the Id of the Agent is returned in 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/browserstack

Input parameters

Examples

Curl

curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' -d '{ \
"Title": "My Remote Agent", \
"Description": "Remote Agent", \
"UserName": "LeapworkUser", \
"AccessKey": "Password", \
"OSType": "Windows", \
"OSVersion": "10", \
"Browser": "Chrome", \
"BrowserVersion": "latest", \
"LocalIdentifier": "local", \
"IsWebLocal": "true"
}' 'http://{controllerMachine}:{controllerPort}/api/v4/agents/create/browserstack'

PowerShell 

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

$requestBody = @'
{
    "Title": "My Remote Agent",
    "Description": "Remote Agent",
    "UserName": "LeapworkUser",
    "AccessKey": "Password",
    "OSType": "Windows",
    "OSVersion": "10",
    "Browser": "Chrome",
    "BrowserVersion": "latest",
    "LocalIdentifier": "local",
    "IsWebLocal": "true"
}
'@ 

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/agents/create/browserstack" -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)