Delete Agent by Id

Description

The endpoint Delete Agent by Id is used to delete an existing Agent in Leapwork. After the successful deletion of the Agent, the returned response contains information like: ‘AgentId’, ‘IsSuccessful’, etc.

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

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

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/agents/delete/{agentId}

Input parameters

Examples

Curl

curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb'  'http://{controllerMachine}:{controllerPort}/api/v4/agents/delete/{agentId}'

PowerShell 

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

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/agents/delete/{agentId}" -ContentType "application/json" -Headers $headers -Method DELETE

Response Body

DeleteAgentResponse object:

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)