Update Sauce Labs with TeamId

Description

The endpoint Update Sauce Labs with TeamId is used to update an Agent of Sauce Labs type in Leapwork, based on a specific team. After the successful update of a Sauce Labs, the agent Id  is returned in the response.

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

Please note this endpoint will work with the Leapwork Enterprise Edition only. 

Request URL

(PUT) http://{controllerMachine}:{controllerPort}/api/v4/agents/update/{teamId}/saucelabs/{agentId}

Input parameters

Examples

Curl

curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' -d '{ \

"Title": "My Sauce Labs Agent Environment", \

"Description": "Sauce Labs Agent", \

"HostName": "192.168.1.100", \

"AccessKey": "Password", \
"OSType": "Windows", \
"OSVersion": "10", \
"Browser": "Chrome", \
"BrowserVersion": "latest", \
"MobileDevice": "Android GoogleAPI Emulator",\

"ScreenResolution": { \

     "Width": 0, \

     "Height": 0 \

   }, \

}' 'http://localhost:9001/api/v4/agents/update/2226f0c6-71a8-46fd-8f76-9a4d6d87d864/saucelabs/1a8d0f39-ce50-4a35-bed1-770b4de3f957'

PowerShell 

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

$requestBody = @'

{

   "Title": "My Sauce Labs Agent Environment",

   "Description": "Sauce Labs Agent",

   "HostName": "192.168.1.100",

   "AccessKey": "Password",
   "OSType": "Windows",
   "OSVersion": "10",
   "Browser": "Chrome",
   "BrowserVersion": "latest",
   "MobileDevice": "Android GoogleAPI Emulator",

   "ScreenResolution": {

     "Width": 0,

     "Height": 0

    },

}

'@

Invoke-WebRequest -Uri "http://localhost:9001/api/v4/agents/update/2226f0c6-71a8-46fd-8f76-9a4d6d87d864/saucelabs/1a8d0f39-ce50-4a35-bed1-770b4de3f957" -ContentType "application/json" -Headers $headers -Method PUT -Body $requestBody

Response

Update agent and returns true for successful operation completion in the response.

{

"$id": "1",

"AgentId": "1a8d0f39-ce50-4a35-bed1-770b4de3f957",

"IsSuccessful": true

}

Response object

Response Code

200 (OK)

401 (Unauthorized - eg: “Incorrect Accesskey”)

403 (Forbidden – eg: “AccessKey does not have the relevant scope permission”)

404 (Not Found – eg: “Asset not found")

500 (Internal Server Error)