Create selenium grid

Description

The endpoint 'Create selenium grid' is used to create an environment of Selenium Grid type in Leapwork. After successful creation of Selenium Grid 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/seleniumgrid

Input parameters

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/v3/enviroments/create/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/v3/environments/create/seleniumgrid" -ContentType "application/json" -Headers $headers -Method PUT  -Body $requestBody

Response Body

CreateEnvironmentResponse object:

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)