Create Browser Stack With TeamID

Description

The endpoint Create Browser Stack With TeamId is used to create a BrowserStack Agent under a specified team in LEAPWORK. After the successful creation of a BrowserStack Agent, the Id of the Agent is returned in response.

Please note this endpoint will work with LEAPWORK Enterprise edition only. 

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/teamid/browserstack

Input parameters

Property Type Description Comments
teamId string The teamid is a unique Id for the team defined under the LEAPWORK Enterprise Edition. teamId can be fetched from the Response Body of Get All Team endpoint
requestBody application/json

Unique identifiers for the BrowserStack Agent comprising the following parameters:

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

Kindly refer to the documentation for Agents for more details on the usage.

 

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/teamid/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/teamid/browserstack" -ContentType "application/json" -Headers $headers -Method PUT  -Body $requestBody

Response Body

CreateAgentResponse object:

{

  "$id": "1",

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

}

 

Response Object

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


Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)