Create Selenium Grid


The endpoint Create Selenium Grid is used to create an Agent of Selenium Grid type in Leapwork. After the successful creation of a Selenium Grid Agent, the Id of the Agent is returned in the response.

The details of the created Agent can be validated with the help of the Get Agent by Id endpoint.

Request URL


Input parameters

Property Type Description Comments
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.




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/seleniumgrid'


$headers = @{}

$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/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)