Create browser stack

Description

The endpoint 'Create browser stack' is used to create an environment of Browser Stack type in LEAPWORK. After successful creation of Browser Stack environment, the Id of the environment is returned in response.

The details of the created environment can be validated with the help of  Get environment by id endpoint.

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/environments/create/browserstack

Input parameters

Property Type Description Comments
requestBody application/json

Unique identifiers for the Browser Stack environment comprising following parameters:

  • IsWebLocal
  • Title
  • Description
  • UserName
  • AccessKey
  • LocalIdentifier
  • OSType
  • OSVersion
  • Browser
  • BrowserVersion

Kindly refer the documentation for Environments for more details on the usage.

 

Examples

Curl


curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' -d '{ \
"Title": "My Remote Agent Environment", \
"Description": "Remote Agent", \
"UserName": "LeapworkUser", \
"AccessKey": "Password", \
"OSType": "Windows", \
"OSVersion": "10", \
"Browser": "Chrome", \
"BrowserVersion": "latest", \
"LocalIdentifier": "local", \
"IsWebLocal": "true"

}' 'http://{controllerMachine}:{controllerPort}/api/v3/enviroments/create/browserstack'

PowerShell 

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

$requestBody = @'
{
    "Title": "My Remote Agent Environment",
    "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/v3/environments/create/browserstack" -ContentType "application/json" -Headers $headers -Method PUT  -Body $requestBody

Response Body

CreateEnvironmentResponse object:

{

  "$id": "1",

  "EnvironmentId": "4d9c09fe-7ced-4494-8841-378491ebc899"

}

 

Response Object

Field Type Description Values
$id String ID of internal item(Folder/ Flow/Element etc.)  
EnvironmentId String ID of the environment created  


Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)