Get information about all agents#


GET https://{hostname}:{port}
Accept: application/json

Parameter Type Required Description
active boolean false Specify true (the default) to include active agents.Specify false to hide active agents; this option is deprecated.
inactive boolean false Deprecated. This parameter applies only to agents that were inactivated in versions prior to version 6.0. Agents in versions later than 6.0 can not be inactivated. Specify true to include these inactive agents; the default is false.
Parameter Type Required Description
Accept application/json true  


curl -k -u jsmith:passwd 


Example response#

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

Related CLI command: getAgents.

Parent topic: agentCLI resource