Create Selenium Grid with TeamId

Description

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

Please note this endpoint will work with the 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/seleniumgrid

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 Selenium Grid Agent comprising the following parameters:

  • Port
  • HostName
  • Title
  • Description
  • UserProfile
  • PlatformName
  • Browser
  • Version

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 '{ \
"Port": "4444", \
"HostName": "Remote Agent", \
"Title": "My Test Grid", \
"Description": "Selenium Grid", \
"UserProfile": "", \
"PlatformName": "Windows", \
"Browser": "Chrome", \
"Version": "latest"

}' 'http://{controllerMachine}:{controllerPort}/api/v4/agents/create/teamid/seleniumgrid'

PowerShell 

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

$requestBody = @'
{
    "Port": "4444",,
    "HostName": "Remote Agent",
    "Title": "My Test Grid",
    "Description": "Selenium Grid",
   
"UserProfile": "",
    "PlatformName": "Windows",
    "Browser": "Chrome",
    "Version": "latest"

}
'@ 

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