How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acronis Vault Manager REST API

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

Acronis Vault Manager REST API is one of 21 APIs that Acronis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Acronis, Storage, and Vault Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 65 operations across 48 paths, and defines 69 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://dev-cloud.acronis.com/api/vault_manager/v1.

65 operations 48 paths 69 schemas 10 DELETE29 GET4 PATCH17 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://{datacenter}.acronis.com/api/vault_manager/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Acronis Vault Manager REST API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the password and authorizationCode flows, exposing 10 scopes.

Paths & Operations 65

Across 48 paths, the API surfaces 65 operations — 10 DELETE, 29 GET, 4 PATCH, 17 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Operations 65
GET
/backups
Fetches a list of backups.
Fetch backups 28 params → 200
DELETE
/backups
Deletes backups containing selected resources.
Delete backups 2 params → 200400500
GET
/backed_up_resources
Fetches a list of backed up resources.
Fetch backed up resources 10 params → 200
GET
/archives
Fetches a list of archives.
Fetch archives 31 params → 200
DELETE
/archives
Deletes archives containing selected resources.
Delete archives 6 params → 200400500
GET
/archives/{archiveID}/backups
Fetches a list of backups within the archive.
Fetch archive backups 21 params → 200
GET
/vaults
Fetches a list of vaults.
Fetch vaults 24 params → 200
POST
/vaults
Creates or attaches a vault. Issues corresponding commands to agents. If commands are completed successfully, Vault Manager will store the new vault record.
Create or attach vault body → 201
POST
/vaults/refresh
Sets an agent task to refresh vaults.
Refresh vaults body → 200400500
GET
/vaults/{vaultID}
Fetches a vault.
Fetch vault 5 params → 200400404500
DELETE
/vaults/{vaultID}
Unregisters, deletes or detaches a vault.
Delete vault 2 params → 204400404409500
GET
/vaults/{vaultID}/archives
Fetches a list of vault archives.
Fetch vault archives 32 params → 200
DELETE
/vaults/{vaultID}/archives
Deletes specified archives from the vault.
Delete vault archives 6 params → 200400500
POST
/vaults/{vaultID}/archives/refresh
Sets an agent task to refresh specified vault archives.
Refresh vault archives 1 param body → 200400500
GET
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}
Fetches a backup from the vault archive.
Fetch vault archive backup 5 params → 200400404500
PUT
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status
Sets the validation status for backup in the vault archive. Writes the result of backup validation plan.
Set vault archive backup validation status 3 params body → 200400500
GET
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_full
Fetches the validated full screenshot of a backup in the vault archive.
Fetch full vault archive backup screenshot 3 params → 303404500
GET
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_preview
Fetches the validated screenshot preview of a backup in the vault archive.
Fetch vault archive backup screenshot preview 3 params → 303404500
PUT
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status
Adds Automated Test Failover Validation (ATF) status for backup. Write result of backup validation plan.
Add ATF validation status 3 params body → 204400500
GET
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_full
Fetches validated full screenshot for backup.
Fetch full screenshot 3 params → 303404500
GET
/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_preview
Fetches validated screenshot preview for backup.
Fetch screenshot preview 3 params → 303404500
GET
/vaults/{vaultID}/archives/{archiveID}/backup_timestamps
Fetches a list of timestamps when the backups were made. By default, groups backups by 24 hours.
Fetch vault archive backup timestamps 12 params → 200400500
GET
/vaults/{vaultID}/archives/{archiveID}/backups
Fetches a list of vault archive backups.
Fetch vault archive backups 22 params → 200
DELETE
/vaults/{vaultID}/archives/{archiveID}/backups
Deletes vault archive backups.
Delete vault archive backups_0 5 params → 200400500
POST
/vaults/{vaultID}/archives/{archiveID}/backups/delete
Sets the backup deletion tasks to appropriate agent.
Delete vault archive backups_1 5 params body → 200
GET
/vaults/{vaultID}/archives/{archiveID}/replication_status
Fetches archive geo-replication status.
Fetch archive geo-replication status 2 params → 200
GET
/vaults/{vaultID}/config
Fetches the vault configuration.
Fetch vault configuration 1 param → 200400404500
PATCH
/vaults/{vaultID}/config
Updates the vault configuration.
Update vault configuration 1 param body → 200204404409500
GET
/vaults/{vaultID}/stats
Fetches the vault statistics.
Fetch vault statistics 1 param → 200400404500
POST
/vaults/{vaultID}/stats
Updates the vault statistics.
Update vault statistics 1 param body → 204
GET
/vaults/{vaultID}/agents
Fetches a list of agents managing the vault.
Fetch vault agents 1 param → 200
POST
/vaults/{vaultID}/change_password
Available in on-premises version only. Change password for the encrypted vault.
Change encrypted vault password 1 param body → 204
POST
/vaults/{vaultID}/change_credentials
Available in on-premises version only. Change credentials for the managed vault.
Change vault credentials 1 param body → 204
POST
/vaults/{vaultID}/replace_vault_password
Available in on-premises version only. Replaces the password of an encrypted vault.
Replace encrypted vault password 1 param body → 204
GET
/sync/archives
Fetches the archives sync information.
Fetch archives sync info 4 params → 200
POST
/sync/archives
Updates a batch of archives.
Update archives batch body → 200207404
GET
/sync/backups
Fetches the backups sync information.
Fetch backups sync info 4 params → 200
POST
/sync/backups
Updates a batch of backups.
Update backups batch body → 200207404
GET
/sync/vaults
Fetches the vaults sync information.
Fetch vaults sync info 5 params → 200
POST
/sync/vaults
Adds a batch of vaults.
Add vaults batch body → 201
PUT
/sync/vaults/{vaultID}
Registers or updates a vault.
Register or update vault 1 param body → 201400409500
DELETE
/sync/vaults/{vaultID}
Marks the vault as deleted in the Vault Manager database.
Soft delete vault 2 params → 204404409500
POST
/sync/vaults/{vaultID}/agents
Binds agents to the vault.
Bind agents to vault 1 param body → 200
POST
/sync/vaults/{vaultID}/index_catalog_status
Updates the index catalog status of vault.
Update vault index catalog status 1 param body → 204
PATCH
/sync/vaults/{vaultID}/stats
Updates the specified fields of vault stats.
Update vault stats 1 param body → 200400404500
PUT
/sync/vaults/{vaultID}/archives/{archiveID}
Adds an archive to the vault.
Add archive to vault 2 params body → 201400404500
PATCH
/sync/vaults/{vaultID}/archives/{archiveID}
Updates an archive in the vault.
Update archive 2 params body → 204400404500
DELETE
/sync/vaults/{vaultID}/archives/{archiveID}
Marks the archive as deleted in the Vault Manager database.
Soft delete archive 3 params → 204400404500
PUT
/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}
Adds a new backup to the vault archive.
Add backup 3 params body → 201400404500
PATCH
/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}
Updates a backup in the vault archive.
Update backup 3 params body → 204400404500
DELETE
/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}
Marks the backup as deleted in the Vault Manager database.
Soft delete backup 7 params → 204400404500
DELETE
/sync/agents/{agentID}
Deletes an agent.
Delete agent 1 param → 200
POST
/sync/storage_nodes
Available in on-premises version only. Registers a new storage node.
Register storage node_0 1 param body → 201400500
GET
/stats
Fetches statistics for archives that meet the specified conditions.
Fetch archive stats 2 params → 200400404500
GET
/storage_nodes
Available in on-premises version only. Fetches a list of all registered storage nodes.
Fetch registered storage nodes → 200400500
POST
/storage_nodes
Available in on-premises version only. Registers a new storage node.
Register storage node_1 body → 201400500
POST
/storage_nodes/{storageNodeID}/checkuser
Available in on-premises version only. Checks whether the provided user credentials can access the storage node.
Check user access 1 param body → 200400404500
POST
/storage_nodes/{storageNodeID}/check_location
Available in on-premises version only. Attempts to find a vault by the provided path.
Find vault by path 1 param body → 200400404500
DELETE
/abgw_storages/{storageID}
Available in on-premises version only. Unregisters the storage from account server and detach all its vaults.
Unregister storage 3 params → 200
GET
/storage_dirs/{storageID}
Available in on-premises version only. Fetches a list of top level storage folders. Detached folders are always listed. Attached folders listed depending on the includeAttached parameter value.
Fetch storage folders 2 params → 200
GET
/storage_dirs/{storageID}/{path}
Available in on-premises version only. Fetches a list of storage folders in path. Detached folders are always listed. Attached folders listed depending on the includeAttached parameter value.
Fetch storage folders in path 3 params → 200
GET
/healthcheck
Health check route. Returns basic information about service.
Health check → 200
GET
/search_index_size_stats/{tenantID}
Fetches a list of archives and their search index sizes for the tenant.
Fetch archive search index size stats 2 params → 200
GET
/storage_usage_stats
Fetches the storage usage counters per tenant.
Fetch storage usage stats → 200
GET
/antimalware_scan_stats
Fetches the antimalware backup scan counters.
Fetch antimalware scan stats 2 params → 200

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are archive (51 properties), item0_28 (37 properties), item0 (37 properties), vault_full_info (26 properties). Each schema is shown below with its type and property counts.

datetime_fn
string
A filter by date and time in RFC 3339 format with the support for comparison operators. Available operators: lt - less than gt - greater than le - less than or…
storage_type
string
Vault storage type.
items
string
Backup type.
items_1
string
Reason why Backup was created.
archive_id
string
Universally unique identifier.
tenant_id
Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.
storage_type_2
string
Vault storage type.
items_3
object
Volume description.
6 properties
tapes_for_restore
array
checksum_validation
string
Value of backup validation status.
items_4
string
Archive type.
items_5
string
Format of archive.
vault_id
string
Universally unique identifier.
uuid
string
Universally unique identifier.
id
string
Universally unique identifier.
item1
string
Numeric identifier.
vault_info_page
object
2 properties
vault_create_request
object
Request to add new vault.
4 properties 2 required
vault_refresh_task
object
Vault refresh task.
7 properties
vault_full_info
object
Full info about the vault.
26 properties 4 required
archive_refresh_task
object
Archive refresh task.
7 properties 1 required
archive_id_6
string
Universally unique identifier.
tenant_id_7
Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.
storage_type_8
string
Vault storage type.
items_9
object
Volume description.
6 properties
tapes_for_restore_10
array
checksum_validation_11
string
Value of backup validation status.
vm_heartbeat_validation
string
Value of backup validation status.
vault
object
Vault description.
18 properties 4 required
id_12
string
Universally unique identifier.
items_13
object
Composite archive ID that includes vault ID.
2 properties 2 required
error
object
Base error object.
7 properties 2 required
item0
object
Backup description.
37 properties 4 required
items_14
object
Composite backup ID that includes vault and archive ID. Tenant ID has meaning in case where vault ID is not unique.
5 properties 3 required
archive_id_15
string
Universally unique identifier.
managing_agent_id
string
Universally unique identifier.
storage_type_16
string
Vault storage type.
vault_info
object
Vault info.
4 properties 1 required
id_response
object
1 property
items_17
string
Universally unique identifier.
archive
object
Archive description.
51 properties 6 required
backup_create_request
Backup creation request.
backup_update_request
object
Backup updating request, modified partial version of the Backup. Identified by vaultid, archiveid and backupid.
storage_node_extended
object
Extended info about Storage Node and its vaults.
2 properties 1 required
validate_credentials
object
Request to add new vault.
2 properties
find_location
object
Checks if the path provided contains a vault.
2 properties
tenant_id_18
Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.
item0_19
object
9 properties
tenant_id_20
Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.
access_address
string
Hostname or IP address of Acronis Storage Node to create vault on.
config
object
Vault description.
18 properties 4 required
protected_storage
object
1 property
tapes
array
item1_21
object
Local ABGW Vault settings.
2 properties 1 required
item2
object
Amazon S3 Vault settings.
6 properties
item3
object
S3 Compatible Vault settings.
7 properties 4 required
item4
object
Wasabi S3 Vault settings.
6 properties 6 required
tenant_id_22
Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.
storage_type_23
string
Vault storage type.
items_24
object
Volume description.
6 properties
tapes_for_restore_25
array
checksum_validation_26
string
Value of backup validation status.
stats
object
Vault statistics.
10 properties
stats_27
object
Additional information about slices.
4 properties
orphanage
object
Archive orphanage status description.
1 property 1 required
item0_28
object
Backup description.
37 properties 4 required
config_29
object
Vault description.
18 properties 4 required
items_30
object
Volume description.
6 properties
checksum_validation_31
string
Value of backup validation status.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acronis-vaultman-v1-openapi.json Raw ↑

Other APIs Acronis publishes across the network.

Acronis Resource and Policy Management API
Acronis Advanced Automation API
Acronis Event Manager API
Acronis Disaster Recovery Service API
Acronis Endpoint Detection and Response API
Acronis Activities API
Acronis Agent Updates API
Acronis Agents API
Acronis Authentication API
Acronis Clients API
Acronis Hardware Nodes API
Acronis Licensing API
Where this information came from

This is an independent, third-party profile of Acronis Vault Manager REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.