Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.0",
"info": {
"title": "Agents API",
"version": "2"
},
"paths": {
"/agents": {
"get": {
"operationId": "FetchAgents",
"description": "Fetches all registered agents seen from specified tenant.\n\nResult includes all agents registered in this tenant and in all its child tenants that don't\nblock parent access using visibility barrier.\n",
"parameters": [
{
"name": "after",
"description": "Cursor that designates the last element of a previously returned registered agent subset\n(page). If this parameter is provided, the next agent page will be returned in the response\n(according to ordering requirements that were specified in the first request).\nThis parameter is mutually exclusive with all other but limit query parameters.\nClient must treat it as opaque string.\n",
"in": "query",
"schema": {
"description": "Cursor that designates the last element of a previously returned registered agent subset\n(page). If this parameter is provided, the next agent page will be returned in the response\n(according to ordering requirements that were specified in the first request).\nThis parameter is mutually exclusive with all other but limit query parameters.\nClient must treat it as opaque string.\n",
"example": "aGVhbHRoY2hlY2s6C",
"type": "string"
}
},
{
"name": "before",
"description": "Cursor that designates the first element of a previously returned registered agent subset\n(page). If this parameter is provided, the previous agent page will be returned in the response\n(according to ordering requirements that were specified in the first request).\nThis parameter is mutually exclusive with all other but limit query parameters.\nClient must treat it as opaque string.\n",
"in": "query",
"schema": {
"description": "Cursor that designates the first element of a previously returned registered agent subset\n(page). If this parameter is provided, the previous agent page will be returned in the response\n(according to ordering requirements that were specified in the first request).\nThis parameter is mutually exclusive with all other but limit query parameters.\nClient must treat it as opaque string.\n",
"example": "aGVhbHRoY2hlY2s6C",
"type": "string"
}
},
{
"name": "hostname",
"description": "Either a full name or a name segment (name mask) of a host where registered agent\nis installed. If this parameter is provided, only agents which host names match the parameter\nvalue are returned. Name mask is specified using one of match-like functions:\n- `hlike` - host name starts with specified string.\n- `like` - host name contains specified string in any position.\n- `tlike` - host name ends with specified string.\n",
"in": "query",
"schema": {
"description": "Either a full name or a name segment (name mask) of a host where registered agent\nis installed. If this parameter is provided, only agents which host names match the parameter\nvalue are returned. Name mask is specified using one of match-like functions:\n- `hlike` - host name starts with specified string.\n- `like` - host name contains specified string in any position.\n- `tlike` - host name ends with specified string.\n",
"example": "hlike(server1)",
"type": "string"
}
},
{
"name": "limit",
"description": "Maximum number of registered agents to return in the response. If this parameter is not provided or\nset to zero, there is no limit on number of returned agents.\n",
"in": "query",
"schema": {
"description": "Maximum number of registered agents to return in the response. If this parameter is not provided or\nset to zero, there is no limit on number of returned agents.\n",
"example": 100,
"type": "integer"
}
},
{
"name": "online",
"description": "Flag that filters returned registered agents by their current responsiveness.\nIf true, only responsive agents will be returned. If false, only irresponsive agents will be returned.\n",
"in": "query",
"schema": {
"description": "Flag that filters returned registered agents by their current responsiveness.\nIf true, only responsive agents will be returned. If false, only irresponsive agents will be returned.\n",
"example": true,
"type": "boolean"
}
},
{
"name": "order",
"description": "Ordering requirements on returned sequence of registered agents. They are specified as\na comma-separated list of order specifications for agent attributes. Each attribute order\nspecification is either asc (non-descending order) or desc (non-ascending order) function\napplied to an attribute name.\nCurrently ordering by the following attributes is supported:\n- `hostname` - agents with same host names are further ordered in non-descending order by\ntheir agent identifiers\n",
"in": "query",
"schema": {
"description": "Ordering requirements on returned sequence of registered agents. They are specified as\na comma-separated list of order specifications for agent attributes. Each attribute order\nspecification is either asc (non-descending order) or desc (non-ascending order) function\napplied to an attribute name.\nCurrently ordering by the following attributes is supported:\n- `hostname` - agents with same host names are further ordered in non-descending order by\ntheir agent identifiers\n",
"example": "desc(hostname)",
"type": "string"
}
},
{
"name": "os_family",
"description": "Parameter that filters registered agents by OS family name they were built for. OS family name is case-insensitive.\n",
"in": "query",
"schema": {
"description": "Parameter that filters registered agents by OS family name they were built for. OS family name is case-insensitive.\n",
"enum": [
"UNKNOWN",
"WINDOWS",
"LINUX",
"MACOSX",
"SOLARIS"
],
"example": "SOLARIS",
"type": "string"
}
},
{
"name": "tenant_id",
"description": "Identifier of a tenant subtree root. Only agents that belong to tenants of this subtree\nare returned. If this parameter is missing, value from `X-Apigw-Tenant-Id` header is used.\nIf this header is also missing, tenant identifiers from relevant elements of scope\ncollection of access token are used.\n",
"in": "query",
"schema": {
"description": "Identifier of a tenant subtree root. Only agents that belong to tenants of this subtree\nare returned. If this parameter is missing, value from `X-Apigw-Tenant-Id` header is used.\nIf this header is also missing, tenant identifiers from relevant elements of scope\ncollection of access token are used.\n",
"example": "62",
"type": "string"
}
},
{
"name": "unit",
"description": "Name of registered agent unit. If this parameter is provided, only agents that have at\nleast one of specified units are returned.\n",
"in": "query",
"schema": {
"description": "Name of registered agent unit. If this parameter is provided, only agents that have at\nleast one of specified units are returned.\n",
"example": "atp-agent",
"type": "string"
}
},
{
"name": "up_to_date",
"description": "Flag specifying whether agents with current or outdated software should only be returned.\n",
"in": "query",
"schema": {
"description": "Flag specifying whether agents with current or outdated software should only be returned.\n",
"example": false,
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Collection of registered agents was successfully retrieved.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentCollection"
}
}
}
},
"400": {
"description": "Request is malformed.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"BAD_REQUEST",
"BAD_UNATTENDED_AGENT_UPDATE_SETTINGS",
"UNMARSHALLING_ERROR"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "User authorization failed. There are many reasons for the error.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"UNAUTHORIZED_REQUEST",
"AUTHENTICATION_TIMEOUT"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"GENERAL"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"403": {
"description": "Access was denied for roles a user plays in Platform.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"ACCESS_DENIED"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"500": {
"description": "Service encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"MARSHALLING_ERROR",
"DATABASE_ERROR",
"BAD_RESPONSE",
"COMMUNICATION_ERROR"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
}
},
"security": [
{
"oauth_2_0_user": [
"urn:acronis.com::agent_manager::agent_viewer",
"urn:acronis.com::agent_manager::admin"
]
}
]
},
"delete": {
"operationId": "DeleteAgents",
"description": "Cancels registration of the agents with Platform and deletes their service accounts.",
"parameters": [
{
"name": "id",
"description": "Identifier of agent to be deleted.",
"required": true,
"in": "query",
"schema": {
"description": "Identifier of agent to be deleted.",
"example": "32b9375f-6400-4928-ae4f-5156e8aab21a",
"type": "string"
}
},
{
"name": "force",
"description": "Flag specifying whether agent registration should be cancelled even if this is the\nlast agent instance associated with a resource it manages. This flag is only respected\nfor agents that have MMS unit. Other agents are deleted unconditionally.\n",
"in": "query",
"schema": {
"description": "Flag specifying whether agent registration should be cancelled even if this is the\nlast agent instance associated with a resource it manages. This flag is only respected\nfor agents that have MMS unit. Other agents are deleted unconditionally.\n",
"default": false,
"example": true,
"type": "boolean"
}
}
],
"responses": {
"204": {
"description": "Registration of specified agents with Platform was either successfully cancelled or didn't exist.",
"content": {}
},
"401": {
"description": "User authorization failed. There are many reasons for the error.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"UNAUTHORIZED_REQUEST",
"AUTHENTICATION_TIMEOUT"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"GENERAL"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"403": {
"description": "Access was denied for roles a user plays in Platform.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"ACCESS_DENIED"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"409": {
"description": "Request violates some invariant.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"AGENT_UPDATE_NOT_SUSPENDED",
"CLUSTER_ALREADY_EXISTS",
"CLUSTER_IS_NOT_EMPTY",
"HARDWARE_NODE_ALREADY_EXISTS",
"HARDWARE_NODE_IS_OCCUPIED"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"500": {
"description": "Service encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"MARSHALLING_ERROR",
"DATABASE_ERROR",
"BAD_RESPONSE",
"COMMUNICATION_ERROR"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
}
},
"security": [
{
"oauth_2_0_user": [
"urn:acronis.com::agent_manager::agent_unregistrar",
"urn:acronis.com::agent_manager::admin"
]
}
]
}
},
"/agents/update:force": {
"post": {
"operationId": "RunAgentUpdateNow",
"description": "Launches agent(s) update operation disregarding maintenance window settings, if any.\nNote that if an empty agent ID collection is passed with the request, all tenant's agents\nbecome potential subject of update.\n\nMaximum number of agents being updated simultaneously is limited.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "IDs of agents to update.",
"type": "object",
"properties": {
"agent_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"responses": {
"202": {
"description": "Agent(s) update request was accepted.",
"content": {}
},
"400": {
"description": "Request is malformed.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"BAD_REQUEST",
"BAD_UNATTENDED_AGENT_UPDATE_SETTINGS",
"UNMARSHALLING_ERROR"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "User authorization failed. There are many reasons for the error.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"UNAUTHORIZED_REQUEST",
"AUTHENTICATION_TIMEOUT"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"GENERAL"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"403": {
"description": "Access was denied for roles a user plays in Platform.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"ACCESS_DENIED"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
},
"500": {
"description": "Service encountered an unexpected condition that prevented it from fulfilling the request.",
"content": {
"application/json": {
"schema": {
"description": "REST error object.",
"type": "object",
"required": [
"code",
"domain",
"debug"
],
"properties": {
"code": {
"description": "Domain-specific error code.",
"enum": [
"MARSHALLING_ERROR",
"DATABASE_ERROR",
"BAD_RESPONSE",
"COMMUNICATION_ERROR"
],
"type": "string"
},
"domain": {
"description": "Business domain the error belongs to.",
"enum": [
"AGENT_MANAGER"
],
"type": "string"
},
"debug": {
"description": "Additional information about the error.",
"type": "object",
"required": [
"msg"
],
"properties": {
"msg": {
"description": "Error description.",
"type": "string"
}
}
}
}
}
}
}
}
},
"security": [
{
"oauth_2_0_user": [
"urn:acronis.com::agent_manager::agent_registrar",
"urn:acronis.com::agent_manager::admin"
]
}
]
}
},
"/agents/{agent_id}": {
"get": {
"operationId": "FetchAgent",
"description": "Fetches the specific agent.",
"parameters": [
{
"name": "agent_id",
"description": "The registered agent ID.",
"required": true,
"in": "path",
"schema": {
"description": "The registered agent ID.",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Agent description was successfully retrieved.",
"content": {
"application/json": {
"schema": {
"description": "Agent description.",
"type": "object",
"required": [
"online",
"enabled",
"installer_version",
"meta",
# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acronis/refs/heads/main/openapi/_original/acronis-agents-v2-openapi.json