Get Agent By Id

Description

'Get Agent By Id returns all information about an Agent selected by the {agentId}. On success, the returned response contains information like: ‘Agent Title’, ‘Id’, ‘DateModify’, ‘DateCreation’, ‘IsEnabled’ etc.

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/agent/{agentId}

Optional request parameters

http://{controllerMachine}:{controllerPort}/api/v4/agent/{agentId}?temporary=true
if “temporary=true” parameter is set then agents will get the temporary schedules 

Input parameters

Examples

Curl

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

PowerShell 

$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/agents/{agentId}" -ContentType "application/json" -Headers $headers -Method GET

Response Body

Agent object:

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Incorrect Access Key)

400 (Bad Request, asset not found)

500 (Internal Server Error)