Knowledge base
Tips and tricks Best practice guides, FAQ & more
Find tutorials, guides and use case examples in the
Learning centerCreate LambdaTest with TeamId
The endpoint Create LambdaTest With TeamId is used to create a LambdaTest Agent under a specified team in Leapwork. After the successful creation of a LambdaTest 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.
http://{controllerMachine}:{controllerPort}/api/v4/agents/create/teamid/lambdatest
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 LambdaTest Agent comprising the following parameters:
|
Kindly refer to the Agents documentation for more details on the usage.
|
curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' -d '{ \
"Port": "80", \
"Title": "My LambdaTest Agent", \
"Description": "LambdaTest Agent", \
"HubUserName": "LeapworkUser", \
"SubDomain": "domainName", \
"HubPassword": "Password", \
"OSType": "Windows", \
"OSVersion": "10", \
"Browser": "Chrome", \
"BrowserVersion": "latest"
}' 'http://{controllerMachine}:{controllerPort}/api/v4/agents/create/teamid/lambdatest'
$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/lambdatest" -ContentType "application/json" -Headers $headers -Method PUT -Body $requestBody
CreateAgentResponse object:
{ "$id": "1", "AgentId": "4d9c09fe-7ced-4494-8841-378491ebc899" } |
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)
©2024, Leapwork. All rights reserved.