Get All Agents

Description

Get All Agents returns a list of all Agents currently configured on the Controller. The returned list of Agents will give access to the Name, IDs, UsedBySchedules etc. of the Agent that are needed to call other endpoints in the API. 

Request URL

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

Optional request parameters

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

Examples

Curl

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

PowerShell 

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

Response Body

List of variables:

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

500 (Internal Server Error)