REST API show active agents.

book

Article ID: 221831

calendar_today

Updated On:

Products

CA Automic One Automation

Issue/Introduction

How can a list of active agents be retrieved via the REST API?

Cause

How To.

Environment

Release : 12.3

Component : AUTOMATION ENGINE

Resolution

Active agent can be retrieved with this GET call.

{{URLROOT}}://{{HOSTNAME}}:{{PORT}}/{{APIURL}}/{{APIVERSION}}/{{CLIENT}}/system/agents?active=true

Result:

{
    "data": [
        {
            "active": true,
            "name": "IA",
            "jcl_variant": "IA",
            "platform": "IA",
            "authenticated": true,
            "version": "12.3.0+build.43",
            "hardware": "IA",
            "ip_address": "10.74.240.35",
            "port": 0,
            "software": "IA",
            "linked": true
        },
        {
            "active": true,
            "name": "LVNKTEST000056_UNIX_01",
            "jcl_variant": "UNIX",
            "platform": "UNIX",
            "authenticated": true,
            "version": "12.3.6+build.1623930631118",
            "hardware": "x86_64/4",
            "ip_address": "10.173.42.196",
            "port": 2300,
            "software": "Linux",
            "linked": true
        },
        {
            "active": true,
            "name": "WIN01",
            "jcl_variant": "WINDOWS",
            "platform": "WINDOWS",
            "authenticated": true,
            "version": "12.3.6+hf.2.build.1628511943051",
            "hardware": "x86/8/64",
            "ip_address": "10.74.240.35",
            "port": 2300,
            "software": "WinNT",
            "linked": true
        }
    ],
    "hasmore": false
}