Create Gridlastic With TeamId

Description

The endpoint Create Gridlastic With TeamId is used to create a Gridlastic Agent under a specified team in Leapwork. After the successful creation of a Gridlastic Agent, the Id of the Agent is returned in 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/gridlastic

Input parameters

Examples

Curl

curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' -d '{ \
"Port": "80", \
"Title": "My Gridlastic Agent", \
"Description": "Gridlastic  Agent", \
"HubUserName": "LeapworkUser", \
"SubDomain": "domainName", \
"HubPassword": "Password", \
"OSType": "Windows", \
"OSVersion": "10", \
"Browser": "Chrome", \
"BrowserVersion": "latest"
}' 'http://{controllerMachine}:{controllerPort}/api/v4/agents/create/teamid/gridlastic'

PowerShell 

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

$requestBody = @'
{
    "Port": "80",
    "Title": "My Gridlastic Agent",
    "Description": "Gridlastic Agent",
    "HubUserName": "LeapworkUser",
    "SubDomain": "domainName",
    "HubPassword": "Password",
    "OSType": "Windows",
    "OSVersion": "10",
    "Browser": "Chrome",
    "BrowserVersion": "latest"
}
'@ 

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/agents/create/teamid/gridlastic" -ContentType "application/json" -Headers $headers -Method PUT  -Body $requestBody

Response Body

CreateAgentResponse object:

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)