Get information about all agents

Request

GET https://{hostname}:{port}
    /cli/agentCLI?{parameters}
Accept: {contentType}
Table 1. Request parameters
Parameter Type Required Description
active boolean false
Table 2. Header parameters
Parameter Type Required Description
Accept
  • application/json
  • application/yaml
true

Example

curl -k -u jsmith:passwd 
   
  "https://deployserver.example.com:8443/cli/agentCLI"

Example response

[
  {
    "id": "bdc2019c-78ae-403c-a528-22b31ae3c183",
    "name": "Agent1",
    "active": true,
    "licensed": false,
    "licenseType": "NONE",
    "status": "ONLINE",
    "version": "6.0.1.0.452394",
    "workingDirectory": "/opt/install-dir/agent/var/work/",
    "impersonationPassword": "****",
    "impersonationForce": false,
    "tags": [
    ]
  }
]

Related CLI command: getAgents.