List Agents

List and query all agents.

External Documentation

To learn more, visit the Acronis documentation.

Basic Parameters

Parameter	Description
Hostname	The hostname of the agnet to query by.You can use the following function in your query: hlike - hostname starts with specified string. like - hostname contains specified string in any position. tlike - hostname ends with specified string.
Online	Query by the online status of the agent.
Os Family	Query by the os family of the agent.

Advanced Parameters

Parameter	Description
After	A next page cursor that is returned in a previous return.
Before	A previous page cursor that is returned in a previous return.
Limit	The amount of results to return per page.
Order	The order that the results are returned in.
Tenant ID	Query by the tenant ID of the agent.
Unit	Query by the name of registered agent unit.
Up To Date	Query by the up to date status of the agent.

Example Output

{
    "items": [
        {
            "id": "8f27a66f-71ff-4b5c-b665-75ec0f42b849",
            "core_version": {
                "current": {
                    "release_id": "1.0.0",
                    "build": "42"
                }
            },
            "units": [
                {
                    "name": "atp",
                    "version": {
                        "current": {
                            "release_id": "1.0.0",
                            "build": "42"
                        },
                        "latest": {
                            "release_id": "1.0.1",
                            "build": "57"
                        }
                    }
                },
                {
                    "name": "backup",
                    "version": {
                        "current": {
                            "release_id": "1.0.0",
                            "build": "42"
                        }
                    }
                }
            ],
            "auto_update": true,
            "meta": {},
            "hostname": "server1.acme.local",
            "platform": {
                "family": "WINDOWS",
                "arch": "X64",
                "name": "Windows 2019",
                "version_major": 10,
                "version_minor": 0
            },
            "tenant": {
                "id": "64",
                "name": "ACME"
            },
            "name": "My Appliance 6490-78",
            "online": true,
            "enabled": true,
            "registration_date": "Tue, 04 Jun 2019 18:32:26 +0300",
            "registration_id": "eO2uM8QwSIC3nh0FxiZmjArpW-U",
            "installer_version": {
                "current": {
                    "major": 15,
                    "minor": 0,
                    "build_number": 27714
                }
            },
            "timezone": "+0300"
        }
    ],
    "paging": {
        "cursors": {
            "after": "aGVhbHRoY2hlY2s6C",
            "before": "CiAgdGltZW91dDogMTBzCi"
        }
    }
}

Workflow Library Example

List Agents with Acronis and Send Results Via Email

Preview this Workflow on desktop