AgentCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/acronis/main/json-schema/acronis-agent-collection-schema.json",
  "title": "AgentCollection",
  "description": "Collection of registered agents.",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/acronis-agents-v2-openapi.json#/components/schemas/AgentCollection",
  "type": "object",
  "required": [
    "items",
    "paging"
  ],
  "properties": {
    "items": {
      "description": "Collection of registered agents.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Agent"
      }
    },
    "paging": {
      "description": "Position descriptor of returned collection in entire sequence of agents that satisfy the\nsame filter and ordering requirements as returned agents do.\n",
      "type": "object",
      "required": [
        "cursors"
      ],
      "properties": {
        "cursors": {
          "description": "",
          "type": "object",
          "properties": {
            "after": {
              "description": "Opaque string that designates the last element of a resource page. If this parameter is\nmissing this means that the page is the last one in associated resource sequence.\n",
              "type": "string"
            },
            "before": {
              "description": "Opaque string that designates the first element of a resource page. If this parameter is\nmissing this means that the page is the first one in associated resource sequence.\n",
              "type": "string"
            }
          }
        }
      }
    }
  },
  "$defs": {
    "Agent": {
      "description": "An agent registered with Platform.",
      "type": "object",
      "required": [
        "online",
        "enabled",
        "installer_version",
        "meta",
        "units",
        "name",
        "tenant",
        "platform",
        "registration_date",
        "core_version",
        "id",
        "timezone",
        "auto_update",
        "hostname",
        "registration_id"
      ],
      "properties": {
        "online": {
          "description": "Flag designating if the agent is currently online.",
          "type": "boolean"
        },
        "network": {
          "description": "Agent host's network configuration.",
          "type": "object",
          "required": [
            "network_interfaces"
          ],
          "properties": {
            "gateway": {
              "description": "IP address or host name of the gateway.",
              "type": "string"
            },
            "network_interfaces": {
              "description": "Network interfaces at agent's host.",
              "type": "array",
              "minItems": 1,
              "items": {
                "$ref": "#/$defs/NetworkInterface"
              }
            },
            "dns_server_ip_addresses": {
              "description": "IP addresses of DNS servers. This collection may include addresses of both IPv4 and IPv6 servers.",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "enabled": {
          "description": "Flag designating if the agent is currently enabled.",
          "type": "boolean"
        },
        "comment": {
          "description": "User-added comment on the agent.",
          "type": "string"
        },
        "installer_version": {
          "description": "Agent installer versions.",
          "type": "object",
          "required": [
            "current"
          ],
          "properties": {
            "current": {
              "description": "The currently installed version.",
              "type": "object",
              "required": [
                "minor",
                "build_number",
                "major"
              ],
              "properties": {
                "minor": {
                  "description": "Minor version number.",
                  "type": "integer",
                  "minimum": 0
                },
                "build_number": {
                  "description": "Build number.",
                  "type": "integer",
                  "minimum": 0
                },
                "major": {
                  "description": "Major version number.",
                  "type": "integer",
                  "minimum": 0
                }
              }
            },
            "latest": {
              "description": "The latest available version. It is only present if the latest version is newer than the current one.",
              "type": "object",
              "required": [
                "minor",
                "build_number",
                "major"
              ],
              "properties": {
                "minor": {
                  "description": "Minor version number.",
                  "type": "integer",
                  "minimum": 0
                },
                "build_number": {
                  "description": "Build number.",
                  "type": "integer",
                  "minimum": 0
                },
                "major": {
                  "description": "Major version number.",
                  "type": "integer",
                  "minimum": 0
                }
              }
            }
          }
        },
        "unattended_update": {
          "description": "Details of unattended agent update. If the agent does not support unattended update, the value is absent.",
          "type": "object",
          "required": [
            "automatic",
            "update_channel",
            "status"
          ],
          "properties": {
            "automatic": {
              "description": "Boolean flag specifying whether agent should be automatically updated to the latest version available in its update channel.",
              "default": false,
              "type": "boolean"
            },
            "inherited_from_tenant_id": {
              "description": "If the update details were inherited from a parent tenant, this is the tenant ID. Otherwise, the value is absent.",
              "type": "string"
            },
            "maintenance_window": {
              "description": "Time intervals when agent update is allowed. If the window is not specified, this means that agent can be updated at any time. The window should be ignored if automatic update is disabled.",
              "type": "object",
              "required": [
                "time_from",
                "days_of_week",
                "time_to"
              ],
              "properties": {
                "time_from": {
                  "description": "Time of day when agent maintenance may start. It is agent local time.",
                  "type": "string",
                  "pattern": "^(?:[0-1][0-9]|2[0-3])(?::[0-5][0-9]){2}$",
                  "minLength": 8,
                  "maxLength": 8
                },
                "days_of_week": {
                  "description": "Days of week when agent maintenance may start (window's start time belongs to these days). They can be given in any order but duplicates are not allowed.",
                  "type": "array",
                  "maxItems": 7,
                  "minItems": 1,
                  "uniqueItems": true,
                  "items": {
                    "$ref": "#/$defs/DayOfWeek"
                  }
                },
                "time_to": {
                  "description": "Time of day agent maintenance must complete before. It is agent local time. If this time is less than or equal to maintenance start time, this means the maintenance may proceed until this time next day.",
                  "type": "string",
                  "pattern": "^(?:[0-1][0-9]|2[0-3])(?::[0-5][0-9]){2}$",
                  "minLength": 8,
                  "maxLength": 8
                }
              }
            },
            "update_channel": {
              "$ref": "#/$defs/AgentUpdateChannel"
            },
            "status": {
              "description": "Current status of unattended update of particular agent.",
              "enum": [
                "OK",
                "SUSPENDED_ON_FAILURES"
              ],
              "type": "string"
            }
          }
        },
        "meta": {
          "description": "The agent metadata.",
          "type": "object"
        },
        "units": {
          "description": "Components the agent consists of. This can be an empty list if the agent has only Agent Core component installed.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/SoftwareUnit"
          }
        },
        "name": {
          "description": "Agent name as seen by a user.",
          "type": "string"
        },
        "tenant": {
          "description": "Tenant descriptor of the agent owner.",
          "type": "object",
          "required": [
            "id",
            "name"
          ],
          "properties": {
            "id": {
              "description": "The tenant identifier.",
              "type": "string"
            },
            "name": {
              "description": "The tenant name.",
              "type": "string"
            }
          }
        },
        "platform": {
          "description": "Descriptor of operating system the agent is running on.",
          "type": "object",
          "required": [
            "name",
            "version_minor",
            "family",
            "arch",
            "version_major"
          ],
          "properties": {
            "service_pack": {
              "description": "OS service pack number if applicable.",
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "description": "Full Operating System name.",
              "type": "string"
            },
            "version_minor": {
              "description": "OS minor version number.",
              "type": "integer",
              "format": "int32"
            },
            "sku": {
              "description": "OS stock keeping unit ID.",
              "type": "integer",
              "format": "int32"
            },
            "product_type": {
              "description": "OS product type if applicable.",
              "type": "integer",
              "format": "int32"
            },
            "family": {
              "description": "Operating System family.",
              "enum": [
                "UNKNOWN",
                "WINDOWS",
                "LINUX",
                "MACOSX",
                "SOLARIS"
              ],
              "type": "string"
            },
            "arch": {
              "description": "Operating System target hardware architecture.",
              "enum": [
                "X86",
                "X64",
                "ARM",
                "ARM64"
              ],
              "type": "string"
            },
            "version_major": {
              "description": "OS major version number.",
              "type": "integer",
              "format": "int32"
            },
            "caps": {
              "description": "OS capability mask if applicable.",
              "type": "integer",
              "format": "int32"
            },
            "suite_mask": {
              "description": "OS suite mask if applicable.",
              "type": "integer",
              "format": "int32"
            }
          }
        },
        "registration_date": {
          "description": "Agent registration date in RFC 1123 format with numeric time zone.",
          "type": "string"
        },
        "core_version": {
          "description": "Agent Core version.",
          "type": "object",
          "required": [
            "current"
          ],
          "properties": {
            "current": {
              "description": "The currently installed version.",
              "type": "object",
              "required": [
                "build",
                "release_id"
              ],
              "properties": {
                "build": {
                  "description": "Build number.",
                  "type": "string"
                },
                "release_id": {
                  "description": "Release identifier.",
                  "type": "string"
                },
                "release_name": {
                  "description": "Human-readable release name.",
                  "type": "string"
                }
              }
            },
            "latest": {
              "description": "The latest available version. It is only present if the latest version is newer than the current one.",
              "type": "object",
              "required": [
                "build",
                "release_id"
              ],
              "properties": {
                "build": {
                  "description": "Build number.",
                  "type": "string"
                },
                "release_id": {
                  "description": "Release identifier.",
                  "type": "string"
                },
                "release_name": {
                  "description": "Human-readable release name.",
                  "type": "string"
                }
              }
            }
          }
        },
        "id": {
          "description": "Unique agent ID. This must be valid string representation of a UUID. The ID is used for client ID construction of the agent service account.",
          "type": "string"
        },
        "timezone": {
          "$ref": "#/$defs/TimeZoneOffset"
        },
        "distribution_type": {
          "description": "Software distribution type.",
          "type": "string"
        },
        "auto_update": {
          "description": "Flag specifying whether the agent is configured to update in automatic unattended mode.\nDeprecated. Use 'unattended_update' property instead: if it is absent, the agent cannot\nupdate automatically; otherwise, check value of 'unattended_update.automatic' property.\n",
          "type": "boolean"
        },
        "hostname": {
          "description": "Host name.",
          "type": "string"
        },
        "registration_id": {
          "description": "Agent registration ID.",
          "type": "string"
        }
      }
    },
    "AgentUpdateChannel": {
      "description": "Source of new agent versions.",
      "enum": [
        "CURRENT",
        "STABLE"
      ],
      "type": "string"
    },
    "DayOfWeek": {
      "description": "Day of week specifier.",
      "enum": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ],
      "type": "string"
    },
    "NetworkInterface": {
      "description": "A network interface of a host.",
      "type": "object",
      "required": [
        "cidr_notations"
      ],
      "properties": {
        "cidr_notations": {
          "description": "Network IP addresses and their associated network masks in CIDR notation. This collection may include items for both IPv4 and IPv6 protocol versions.",
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string"
          }
        },
        "mac_address": {
          "description": "MAC address of the network interface.",
          "type": "string"
        }
      }
    },
    "SoftwareUnit": {
      "description": "Unit name. This must be specified in Agent Manager configuration and there must be corresponding client role in Backup Account Server configuration.",
      "type": "object",
      "required": [
        "name",
        "version"
      ],
      "properties": {
        "name": {
          "description": "Unit name.",
          "type": "string"
        },
        "version": {
          "description": "Unit version.",
          "type": "object",
          "required": [
            "current"
          ],
          "properties": {
            "current": {
              "description": "The currently installed version.",
              "type": "object",
              "required": [
                "build",
                "release_id"
              ],
              "properties": {
                "build": {
                  "description": "Build number.",
                  "type": "string"
                },
                "release_id": {
                  "description": "Release identifier.",
                  "type": "string"
                },
                "release_name": {
                  "description": "Human-readable release name.",
                  "type": "string"
                }
              }
            },
            "latest": {
              "description": "The latest available version. It is only present if the latest version is newer than the current one.",
              "type": "object",
              "required": [
                "build",
                "release_id"
              ],
              "properties": {
                "build": {
                  "description": "Build number.",
                  "type": "string"
                },
                "release_id": {
                  "description": "Release identifier.",
                  "type": "string"
                },
                "release_name": {
                  "description": "Human-readable release name.",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "TimeZoneOffset": {
      "description": "Agent's time zone offset from UTC time zone in SHHMM format, where:\n  \n  - S is either '+' or '-'\n  - HH is number of hours [00,23]\n  - MM is number of minutes [00,59]\n\nFor zero offset, 'UTC' string can be used.\n",
      "type": "string",
      "pattern": "^UTC|(?:\\+|-)(?:[0-1][0-9]|2[0-3])[0-5][0-9]$"
    }
  }
}