Acronis Vault Manager REST API

The Acronis Vault Manager REST API allows users to manage and interact with their Acronis Vault storage solutions programmatically.

Operations 65

GET /backups #
DELETE /backups #
GET /backed_up_resources #
GET /archives #
DELETE /archives #
GET /archives/{archiveID}/backups #
GET /vaults #
POST /vaults #
POST /vaults/refresh #
GET /vaults/{vaultID} #
DELETE /vaults/{vaultID} #
GET /vaults/{vaultID}/archives #
DELETE /vaults/{vaultID}/archives #
POST /vaults/{vaultID}/archives/refresh #
GET /vaults/{vaultID}/archives/{archiveID}/backups/{backupID} #
PUT /vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status #
GET /vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_full #
GET /vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_preview #
PUT /vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status #
GET /vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_full #
GET /vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_preview #
GET /vaults/{vaultID}/archives/{archiveID}/backup_timestamps #
GET /vaults/{vaultID}/archives/{archiveID}/backups #
DELETE /vaults/{vaultID}/archives/{archiveID}/backups #
POST /vaults/{vaultID}/archives/{archiveID}/backups/delete #
GET /vaults/{vaultID}/archives/{archiveID}/replication_status #
GET /vaults/{vaultID}/config #
PATCH /vaults/{vaultID}/config #
GET /vaults/{vaultID}/stats #
POST /vaults/{vaultID}/stats #
GET /vaults/{vaultID}/agents #
POST /vaults/{vaultID}/change_password #
POST /vaults/{vaultID}/change_credentials #
POST /vaults/{vaultID}/replace_vault_password #
GET /sync/archives #
POST /sync/archives #
GET /sync/backups #
POST /sync/backups #
GET /sync/vaults #
POST /sync/vaults #
PUT /sync/vaults/{vaultID} #
DELETE /sync/vaults/{vaultID} #
POST /sync/vaults/{vaultID}/agents #
POST /sync/vaults/{vaultID}/index_catalog_status #
PATCH /sync/vaults/{vaultID}/stats #
PUT /sync/vaults/{vaultID}/archives/{archiveID} #
PATCH /sync/vaults/{vaultID}/archives/{archiveID} #
DELETE /sync/vaults/{vaultID}/archives/{archiveID} #
PUT /sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID} #
PATCH /sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID} #
DELETE /sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID} #
DELETE /sync/agents/{agentID} #
POST /sync/storage_nodes #
GET /stats #
GET /storage_nodes #
POST /storage_nodes #
POST /storage_nodes/{storageNodeID}/checkuser #
POST /storage_nodes/{storageNodeID}/check_location #
DELETE /abgw_storages/{storageID} #
GET /storage_dirs/{storageID} #
GET /storage_dirs/{storageID}/{path} #
GET /healthcheck #
GET /storage_usage_stats #
GET /antimalware_scan_stats #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vault-manager-rest-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

acronis-vaultman-v1-openapi.json Raw ↑
{
  "openapi": "3.0.0",
  "info": {
    "title": "Vault Manager API",
    "version": "v1"
  },
  "paths": {
    "/backups": {
      "get": {
        "operationId": "Fetch backups",
        "description": "Fetches a list of backups.",
        "x-ExtJS": "VaultManager.ListBackups",
        "parameters": [
          {
            "name": "vaultId",
            "description": "ID of vault to search archives for.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "ID of vault to search archives for.",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "type",
            "description": "Show only backups of specified archive types.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups of specified archive types.",
              "type": "string"
            }
          },
          {
            "name": "agentId",
            "description": "Show only backups for specified agent.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups for specified agent.",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "updated",
            "description": "Show only backups updated within specified time range.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups updated within specified time range.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/datetime_fn"
              }
            }
          },
          {
            "name": "regtime",
            "description": "Show only backups created or deleted within specified time range.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups created or deleted within specified time range.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/datetime_fn"
              }
            }
          },
          {
            "name": "storageType",
            "description": "Show only backups located in vaults of specified storage types.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups located in vaults of specified storage types.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/storage_type"
              }
            }
          },
          {
            "name": "storageId",
            "description": "Show only backups located in vaults of the storage that is identified by specified storage ID.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups located in vaults of the storage that is identified by specified storage ID.",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "forensic",
            "description": "Show only backups in archives with forensic data or without forensic.\n\nIf not specified, backups are listed regardless of forensic data.\n",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups in archives with forensic data or without forensic.\n\nIf not specified, backups are listed regardless of forensic data.\n",
              "type": "boolean"
            }
          },
          {
            "name": "resourceId",
            "description": "Show only backups for specified resources.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups for specified resources.",
              "type": "array",
              "items": {
                "description": "Universally unique identifier.",
                "type": "string",
                "format": "uuid"
              }
            }
          },
          {
            "name": "changeTag",
            "description": "Show only backups for specified change tag.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups for specified change tag.",
              "type": "string"
            }
          },
          {
            "name": "showDeleted",
            "description": "A flag that specifies what should be added to the list of returned backups:\n\n* 1 - All deleted backups are added to the list of archives.\n* 2 - Only deleted backups marked as immutable are added to the list of backups.\n* 0 - No deleted backups are added to the list of backups.\n",
            "required": false,
            "in": "query",
            "schema": {
              "description": "A flag that specifies what should be added to the list of returned backups:\n\n* 1 - All deleted backups are added to the list of archives.\n* 2 - Only deleted backups marked as immutable are added to the list of backups.\n* 0 - No deleted backups are added to the list of backups.\n",
              "enum": [
                0,
                1,
                2
              ],
              "type": "integer"
            }
          },
          {
            "name": "embed",
            "description": "An array of field names to include in the response.\n\nEach value represents the name of the extension field to be included in the base response.\n",
            "required": false,
            "in": "query",
            "schema": {
              "description": "An array of field names to include in the response.\n\nEach value represents the name of the extension field to be included in the base response.\n",
              "type": "array",
              "items": {
                "enum": [
                  "archive",
                  "automated_test_failover_validation_status",
                  "validation_status",
                  "vault"
                ],
                "type": "string"
              }
            }
          },
          {
            "name": "created",
            "description": "Show only backups created within specified time range.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups created within specified time range.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/datetime_fn"
              }
            }
          },
          {
            "name": "protectedByPassword",
            "description": "Show only backups in protected by password or unprotected by password archives.\n\nIf not specified, backups are listed regardless of their password protection status.\n",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups in protected by password or unprotected by password archives.\n\nIf not specified, backups are listed regardless of their password protection status.\n",
              "type": "boolean"
            }
          },
          {
            "name": "backupType",
            "description": "Show only backups of specified types.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups of specified types.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/items"
              }
            }
          },
          {
            "name": "tapeId",
            "description": "Show only backups for specified tapes.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups for specified tapes.",
              "type": "array",
              "items": {
                "description": "Universally unique identifier.",
                "type": "string",
                "format": "uuid"
              }
            }
          },
          {
            "name": "triggeredBy",
            "description": "Show a list of Backups triggered by specified reason.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show a list of Backups triggered by specified reason.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/items_1"
              }
            }
          },
          {
            "name": "avScanningDate",
            "description": "Show only backups scanned within the specified time range OR never scanned backups if \"none\" is specified.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups scanned within the specified time range OR never scanned backups if \"none\" is specified.",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/datetime_fn"
              }
            }
          },
          {
            "name": "vulnerabilityAssessmentStatus",
            "description": "Show only backups with specified Vulnerability Assessment Result statuses.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups with specified Vulnerability Assessment Result statuses.",
              "type": "array",
              "items": {
                "enum": [
                  "notScanned",
                  "clean",
                  "vulnerable"
                ],
                "type": "string"
              }
            }
          },
          {
            "name": "malwareAssessmentStatus",
            "description": "Show only backups with specified Malware Assessment Result statuses.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Show only backups with specified Malware Assessment Result statuses.",
              "type": "array",
              "items": {
                "enum": [
                  "notScanned",
                  "clean",
                  "malware"
                ],
                "type": "string"
              }
            }
          },
          {
            "name": "includeActions",
            "description": "Calculate and include possible actions in the response.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Calculate and include possible actions in the response.",
              "type": "boolean"
            }
          },
          {
            "name": "targetAgentId",
            "description": "Select target agent to calculate actions.",
            "required": false,
            "in": "query",
            "schema": {
              "description": "Select target agent to calculate actions.",
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "before",
            "description": "Base64-encoded token obtained from the previous response.\nPoints to the end of the page.\n",
            "in": "query",
            "schema": {
              "description": "Base64-encoded token obtained from the previous response.\nPoints to the end of the page.\n",
              "type": "string"
            }
          },
          {
            "name": "after",
            "description": "Base64-encoded token obtained from the previous response.\nPoints to the start of the page.\n",
            "in": "query",
            "schema": {
              "description": "Base64-encoded token obtained from the previous response.\nPoints to the start of the page.\n",
              "type": "string"
            }
          },
          {
            "name": "offset",
            "description": "The number of elements to skip before beginning to return elements.",
            "in": "query",
            "schema": {
              "description": "The number of elements to skip before beginning to return elements.",
              "default": 0,
              "type": "integer"
            }
          },
          {
            "name": "limit",
            "description": "Limit the number of elements to return in one page.",
            "in": "query",
            "schema": {
              "description": "Limit the number of elements to return in one page.",
              "default": 100,
              "type": "integer",
              "maximum": 1000
            }
          },
          {
            "name": "count",
            "description": "Show total count in the response.",
            "in": "query",
            "schema": {
              "description": "Show total count in the response.",
              "default": false,
              "type": "boolean"
            }
          },
          {
            "name": "order",
            "description": "An ordering filter that orders the results by value of the specified properties.\nProperty in inner object can be specified using dot, e.g. orphanage.status.\n\nAvailable operators:\n\n* `asc` - ascending\n* `desc` - descending\n",
            "required": false,
            "in": "query",
            "schema": {
              "description": "An ordering filter that orders the results by value of the specified properties.\nProperty in inner object can be specified using dot, e.g. orphanage.status.\n\nAvailable operators:\n\n* `asc` - ascending\n* `desc` - descending\n",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request was successful.",
            "content": {
              "application/json": {
                "schema": {
                  "example": {
                    "items": [
                      {
                        "vault_id": "885b7fe4-95ce-71fd-fff5-8de5b3cce9bb",
                        "archive_id": "1f8867c2-179f-ef34-159f-84279a18174d",
                        "backup_id": "c2aa0462-dd30-4e08-afce-1bad7cfbf8be",
                        "created": "2018-02-02T01:40:05Z",
                        "size": 70844416,
                        "deleted": false,
                        "tenant_id": "00000000-0000-0000-0000-000000000000",
                        "tenant_locator": "/00000000-0000-0000-0000-000000000000/",
                        "attributes": {
                          "Kind": "full",
                          "MarkedForDeletion": "0",
                          "SliceMediaIDs": ""
                        },
                        "resource_ids": [
                          "EDD63875-4641-44AA-B1A6-BACB4610AA11"
                        ],
                        "source_key": "",
                        "source_usn": 0,
                        "type": "full",
                        "actions": [
                          "restoreDisks",
                          "restoreFiles",
                          "downloadFiles",
                          "deleteByAgent",
                          "validate",
                          "replicate"
                        ],
                        "catalog_status": {
                          "MsTeamsMails": true,
                          "MsTeamsSite": false,
                          "MsTeamsChannel": false
                        },
                        "notarized": false,
                        "tapes": [
                          "7E1DBD9A-7A7A-4D98-AB13-50084215FCDD",
                          "3DBFADA4-D2E9-442E-9942-39685E956EC1",
                          "C2067C48-0819-41E2-9749-4B448793A782"
                        ],
                        "tapes_for_restore": [
                          "3DBFADA4-D2E9-442E-9942-39685E956EC1",
                          "C2067C48-0819-41E2-9749-4B448793A782"
                        ]
                      }
                    ],
                    "paging": {
                      "cursors": {
                        "before": "eyJfdXJsUGF0aCI6WyIvYXBpL3ZhdWx0X21hbmFnZXIvdjEvYXJjaGl2ZXMiXSwib2Zmc2V0IjpbIjAiXX0"
                      }
                    }
                  },
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "paging": {
                      "title": "Paging status",
                      "description": "Paging status.",
                      "type": "object",
                      "additionalProperties": false,
                      "properties": {
                        "total_count": {
                          "description": "Total number of selected items according given filters.",
                          "type": "integer"
                        },
                        "cursors": {
                          "type": "object",
                          "additionalProperties": false,
                          "properties": {
                            "after": {
                              "description": "A cursor that points to the end of the page of data that has been returned.",
                              "type": "string"
                            },
                            "before": {
                              "description": "A cursor that points to the start of the page of data that has been returned.",
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "description": "Backup description.",
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "vault_id",
                          "archive_id",
                          "backup_id",
                          "type"
                        ],
                        "properties": {
                          "vault_id": {
                            "$ref": "#/components/schemas/archive_id"
                          },
                          "archive_id": {
                            "$ref": "#/components/schemas/archive_id"
                          },
                          "backup_id": {
                            "$ref": "#/components/schemas/archive_id"
                          },
                          "created": {
                            "description": "Date and time in RFC 3339 format the backup was created.",
                            "type": "string",
                            "format": "date-time"
                          },
                          "size": {
                            "description": "Size in bytes on backup location.",
                            "type": "integer"
                          },
                          "deduplicated_size": {
                            "description": "Deduplicated size in bytes on backup location.",
                            "type": "integer"
                          },
                          "backed_up_data_size": {
                            "description": "Size in bytes of backed up data in backup.",
                            "type": "integer"
                          },
                          "original_data_size": {
                            "description": "Size in bytes of data that can be restored from this backup; for full backup this value is equal to `backed_up_data_size`.",
                            "type": "integer"
                          },
                          "item_counters": {
                            "title": "Slice item counters",
                            "description": "Counters of items modified during backup.",
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                              "items_added": {
                                "description": "Items added during backup.",
                                "type": "integer"
                              },
                              "items_changed": {
                                "description": "Items changed during backup.",
                                "type": "integer"
                              },
                              "items_removed": {
                                "description": "Items removed during backup.",
                                "type": "integer"
                              }
                            }
                          },
                          "deleted": {
                            "description": "True if the backup is deleted. False otherwise.",
                            "type": "boolean"
                          },
                          "tenant_id": {
                            "$ref": "#/components/schemas/tenant_id"
                          },
                          "tenant_locator": {
                            "description": "Tenant path.",
                            "type": "string"
                          },
                          "resource_ids": {
                            "description": "List of identifiers of backed up resources.",
                            "type": "array",
                            "items": {
                              "description": "ID of backed up resource.",
                              "type": "string"
                            }
                          },
                          "catalog_status": {
                            "description": "Catalog status for backup or backup subtypes.",
                            "type": "object"
                          },
                          "notarized": {
                            "description": "If true, the backup is notarized. False otherwise.",
                            "type": "boolean"
                          },
                          "attributes": {
                            "description": "Any vault-specific or backup-point-specific attributes.",
                            "type": "object"
                          },
                          "vault": {
                            "title": "Vault description",
                            "description": "Vault description.",
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "name",
                              "version",
                              "storage_type",
                              "settings"
                            ],
                            "properties": {
                              "id": {
                                "$ref": "#/components/schemas/archive_id"
                              },
                              "name": {
                                "description": "Name of the vault.",
                                "type": "string"
                              },
                              "uri": {
                                "description": "URI of the vault.",
                                "type": "string"
                              },
                              "version": {
                                "description": "Version of the vault.",
                                "type": "string"
                              },
                              "managing_agent_id": {
                                "$ref": "#/components/schemas/archive_id"
                              },
                              "storage_type": {
                                "$ref": "#/components/schemas/storage_type_2"
                              },
                              "organizational": {
                                "description": "True if vault is online and is created on customer or personal tenant levels. False otherwise.",
                                "type": "boolean"
                              },
                              "settings": {
                                "description": "Any vault type specific settings.",
                                "oneOf": [
                                  {
                                    "type": "object",
                                    "additionalProperties": false,
                                    "properties": {
                                      "comment": {
                                        "type": "string"
                                      },
                                      "storage_type": {
                                        "$ref": "#/components/schemas/storage_type_2"
                                      },
                                      "catalog_type": {
                                        "type": "string"
                                      },
                                      "catalog_uri": {
                                        "type": "string"
                                      },
                                      "encryption_type": {
                                        "enum": [
                                          "CRYPT_NONE",
                                          "CRYPT_AES128",
                                          "CRYPT_AES192",
                                          "CRYPT_AES256",
                                          "CRYPT_GOST"
                                        ],
                                        "type": "string"
                                      },
                                      "encryption_uri": {
                                        "type": "string"
                                      },
                                      "encryption_key": {
                                        "type": "string"
                                      },
                                      "dedup_type": {
                                        "type": "string"
                                      },
                                      "dedup_uri": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  {
                                    "title": "Local ABGW Vault settings",
                                    "description": "Local ABGW Vault settings.",
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "storage_id"
                                    ],
                                    "properties": {
                                      "path": {
                                        "description": "Path on the storage.",
                                        "type": "string"
                                      },
                                      "storage_id": {}
                                    }
                                  },
                                  {
                                    "title": "Amazon S3 Vault settings",
                                    "description": "Amazon S3 Vault settings.",
                                    "type": "object",
                                    "additionalProperties": false,
                                    "properties": {
                                      "connection_id": {
                                        "description": "Connection ID is used to get Amazon credentials from Cloud Connection Service",
                                        "type": "string"
                                      },
                                      "region": {
                                        "description": "Region of the storage",
                                        "type": "string"
                                      },
                                      "storage_class": {
                                        "description": "Storage class",
                                        "enum": [
                                          "STANDARD",
                                          "STANDARD_IA",
                                          "ONEZONE_IA",
                                          "INTELLIGENT_TIERING"
                                        ],
                                        "type": "string"
                                      },
                                      "bucket": {
                                        "description": "Bucket name",
                                        "type": "string"
                                      },
                                      "path": {
                                        "description": "Path on the storage.",
                                        "type": "string"
                                      },
                                      "immutability_days": {
                                        "description": "Object lock duration in days.",
                                        "default": 30,
                                        "type": "integer",
                                        "minimum": 1,
                                        "maximum": 999
                                      }
                                    }
                                  },
                                  {
                                    "title": "S3 Compatible Vault settings",
                                    "description": "S3 Compatible Vault settings.",
                                    "type": "object",
                                    "additionalProperties": false,
                                    "required": [
                                      "cred_id",
                                      "endpoint",
                                      "bucket",
                                      "path"
                                    ],
                                    "properties": {
                                      "cred_id": {
                                        "description": "Cred ID from CredentialStore service used to get s3 credentials",
                                        "type": "string"
                                      },
                                      "s3_auth_flavour": {
                                        "description": "Authentication method",
                                        "default": "authv4",
                                        "enum": [
                                          "authv2",
                                          "authv4"
                                        ],
                                        "type": "string"
                                      },
                                      "cert_verify": {
                                        "description": "Verify server cerificate?",
                                        "default": true,
                                        "type": "boolean"
                                      },
                                      "endpoint": {
                                        "description": "Endpoint of the compatible s3 storage",
                                        "type": "string"
                                      },
                                      "bucket": {
                                        "description": "Bucket name",
                                        "type": "string"
                                      },
                                      "path": {
                                        "description": "Path on the storage.",
                                        "type": "string"
                                      },
                                      "s3_subtype": {
                                        "default": "",
                                        "enum": [
                                          "",
                                          "ACI",
                                          "ImpossibleCloud"
                                        ],
                                        "type": "string"
                                      }
                                    }
   

# --- truncated at 32 KB (642 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acronis/refs/heads/main/openapi/_original/acronis-vaultman-v1-openapi.json