Update Gridlastic
Description
The endpoint Update Gridlastic is used to update an Agent of Gridlastic type in Leapwork. After the successful update of a Gridlastic Agent, 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 Platform Edition only.
Request URL
(PUT) http://{controllerMachine}:{controllerPort}/api/v4/agents/update/gridlastic/{agentId}
Input parameters
|
Field
|
Type
|
Description
|
Comment
|
|
accessKey
|
string
|
An access key is required to restrict unauthorized access to the API.
|
Access Key should include agent scope to access the API.
|
|
agentId
|
string
|
Unique id of agent
|
|
|
requestBody
|
application/json
|
Unique identifiers for the Gridlastic Agent comprising the following parameters:
- Port
- Title
- Description
- HubUserName
- SubDomain
- HubPassword
- OSType
- OSVersion
- Browser
- BrowserVersion
- Screen Resolution
|
Kindly refer to the documentation for Agents for more details on the usage.
|
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",\
"ScreenResolution": { \
"Width": 0, \
"Height": 0 \
}, \
}' 'http://localhost:9001/api/v4/agents/update/gridlastic/1a8d0f39-ce50-4a35-bed1-770b4de3f957'
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",
"ScreenResolution": {
"Width": 0,
"Height": 0
},
}
'@
Invoke-WebRequest -Uri "http://localhost:9001/api/v4/agents/update/gridlastic/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
|
Field
|
Type
|
Description
|
Values
|
|
$id
|
string
|
ID of internal object
|
|
|
AgentId
|
string
|
ID of the Agent updated
|
|
|
IsSuccessful
|
bool
|
Returns ‘true’ for successful operation
|
true| false
|
Response Code
200 (OK)
400 (Bad Request – eg: “Invalid endpoint for Enterprise version")
401 (Unauthorized - eg: “Incorrect Accesskey”)
403 (Forbidden – eg: “AccessKey does not have the relevant scope permission”)
500 (Internal Server Error)
.svg "Leapwork")
