Get information about an agent

This command returns a JSON representation of an agent.

Request

GET https://{hostname}:{port}
    /cli/agentCLI/info?{parameters}

Table 1. Request parameters
Parameter	Type	Required	Description
agent	string	true	Name or ID of the agent

Example

curl -k -u jsmith:passwd 
   
  "https://myserver.example.com:8443/cli/agentCLI/info
  ?agent=myAgent"

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/ibm-ucd/agent/var/work/",
  "impersonationPassword": "****",
  "impersonationForce": false,
  "tags": [
  ],
  "security": {
    "read": true,
    "write": true
  },
  "propSheet": {
    "id": "4efdfe42-467a-4cb9-8594-68d7c3b98038",
    "path": "agents/bdc2019c-78ae-403c-a528-22b31ae3c183/propSheet",
    "version": 6,
    "versionCount": 6,
    "commit": 81,
    "versioned": true
  },
  "extendedSecurity": {
    "read": true,
    "write": true,
    "Edit Agents": true,
    "View Agents": true,
    "teams": [
      {
        "teamId": "ea307e2e-d6be-4092-a7e8-e8e02274de7e",
        "teamLabel": "My team"
      }
    ]
  }
}

Related CLI command: getAgent.

Feedback