{ "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" } } }, { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "compacting_plan_id": { "$ref": "#/components/schemas/archive_id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "archive": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/archive_id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/archive_id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/archive_id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } }, "disks": { "description": "Disks in the Disk-image backup.", "type": "array", "items": { "title": "Disk", "description": "Disk description.", "type": "object", "additionalProperties": false, "properties": { "device_model": { "type": "string" }, "name": { "type": "string" }, "size": { "description": "Disk size in bytes.", "type": "integer" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/items_3" } } } } }, "dynamic_volumes": { "description": "Dynamic volumes in the Disk-image backup.", "type": "array", "items": { "$ref": "#/components/schemas/items_3" } }, "source_key": { "description": "Old agents sync info.", "type": "string" }, "source_usn": { "description": "Old agents sync info.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "last_seen_at": { "description": "Date and time in RFC 3339 format the backup was last seen.", "type": "string", "format": "date-time" }, "change_tag": { "description": "User-defined identifier to mark records affected by this request (obsolete).", "type": "string" }, "failover_check_info": { "title": "Failover check info", "description": "Information about status of failover.", "type": "object", "additionalProperties": false, "properties": { "error": { "description": "Failover check error.", "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "domain": { "type": "string" } } }, "is_critical_error": { "description": "True if check has failed with error that is critical for failover. False otherwise.", "type": "boolean" } } }, "triggered_by": { "description": "Reason why Backup was created.", "enum": [ "patch_management" ], "type": "string" }, "av_scanning_date": { "description": "Date and time in RFC 3339 format when backup was scanned by antivirus. Input timezone is removed by conversion to UTC", "type": "string", "format": "date-time" }, "vulnerability_assessment_result": { "description": "Vulnerability assessment result:\n* 0 - clean.\n* 1 - malicious.\n 2 - unknown.\n 3 - failed.\n* 4 - unsupported.", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "malware_assessment_result": { "description": "Malware assessment result:\n* 0 - clean.\n* 1 - malware.\n* 4 - unsupported (unsupported file system).", "enum": [ 0, 1, 4 ], "type": "integer" }, "type": { "description": "Backup type.", "enum": [ "full", "incremental", "differential", "unknown", "cdp" ], "type": "string" }, "tapes": { "$ref": "#/components/schemas/tapes_for_restore" }, "tapes_for_restore": { "$ref": "#/components/schemas/tapes_for_restore" }, "deleted_immutable": { "description": "True if the backup is marked as deleted immutable. False otherwise.", "type": "boolean" }, "validation_status": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/checksum_validation" }, "checksum_validation": { "$ref": "#/components/schemas/checksum_validation" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/checksum_validation" }, "screenshot_validation": { "$ref": "#/components/schemas/checksum_validation" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } }, "automated_test_failover_validation_status": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "$ref": "#/components/schemas/checksum_validation" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } }, "created_in_network_isolation": { "description": "True if the backup was created after network isolation. False otherwise.", "type": "boolean" } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly", "vault_manager::core_restore", "vault_manager::c2c_restore" ] } ] }, "delete": { "operationId": "Delete backups", "description": "Deletes backups containing selected resources.", "x-ExtJS": "VaultManager.DeleteResourceBackups", "parameters": [ { "name": "resourceID", "description": "ID of resource.", "required": true, "in": "query", "schema": { "description": "ID of resource.", "type": "string", "format": "uuid" } }, { "name": "changeTag", "description": "Tag for run tasks.", "required": false, "in": "query", "schema": { "description": "Tag for run tasks.", "type": "string" } } ], "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/backed_up_resources": { "get": { "operationId": "Fetch backed up resources", "description": "Fetches a list of backed up resources.", "x-ExtJS": "VaultManager.ListBackedUpResources", "parameters": [ { "name": "vaultId", "description": "ID of vault to search backups for.", "required": false, "in": "query", "schema": { "description": "ID of vault to search backups for.", "type": "string", "format": "uuid" } }, { "name": "archiveId", "description": "ID of archive to search backups for.", "required": false, "in": "query", "schema": { "description": "ID of archive to search backups for.", "type": "string", "format": "uuid" } }, { "name": "tapeId", "description": "Filter backups for specified tapes.", "required": false, "in": "query", "schema": { "description": "Filter backups for specified tapes.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "showDeleted", "description": "A flag that specifies what should be added to the list of returned returned backed up resources:\n\n* 1 - Resources contained in live and deleted archives.\n* 2 - Resources contained only in live and immutable archives.\n* 3 - Resources contained in deleted archives only.\n* 0 - Resources contained in live archives only.\n", "required": false, "in": "query", "schema": { "description": "A flag that specifies what should be added to the list of returned returned backed up resources:\n\n* 1 - Resources contained in live and deleted archives.\n* 2 - Resources contained only in live and immutable archives.\n* 3 - Resources contained in deleted archives only.\n* 0 - Resources contained in live archives only.\n", "default": 0, "enum": [ 0, 1, 2, 3 ], "type": "integer" } }, { "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": { "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": { "title": "Resource", "description": "Backed up resource description.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "ID of the resource.", "type": "string" }, "name": { "description": "Name of the resource.", "type": "string" } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/archives": { "get": { "operationId": "Fetch archives", "description": "Fetches a list of archives.", "x-ExtJS": "VaultManager.ListArchives", "parameters": [ { "name": "archiveId", "description": "Show a list of archives of specified archive IDs.", "required": false, "in": "query", "schema": { "description": "Show a list of archives of specified archive IDs.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "showDeleted", "description": "A flag that specifies what should be added to the list of returned archives:\n\n* 1 - All deleted archives are added to the list of archives.\n* 2 - Only deleted archives marked as immutable are added to the list of archives.\n* 3 - Only deleted archives are included to the list of archives, other ones are excluded.\n* 0 - No deleted archives are added to the list of archives.\n", "required": false, "in": "query", "schema": { "description": "A flag that specifies what should be added to the list of returned archives:\n\n* 1 - All deleted archives are added to the list of archives.\n* 2 - Only deleted archives marked as immutable are added to the list of archives.\n* 3 - Only deleted archives are included to the list of archives, other ones are excluded.\n* 0 - No deleted archives are added to the list of archives.\n", "enum": [ 0, 1, 2, 3 ], "type": "integer" } }, { "name": "includeStats", "description": "Include additional information about archive.\n\nIf false or not specified, the `stats` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include additional information about archive.\n\nIf false or not specified, the `stats` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "includeStorageStats", "description": "Include storage-side stats about archive calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include storage-side stats about archive calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "agentId", "description": "Show a list of archives of specified agent ID.", "required": false, "in": "query", "schema": { "description": "Show a list of archives of specified agent ID.", "type": "string", "format": "uuid" } }, { "name": "name", "description": "Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the `wildcard` query string parameter.", "required": false, "in": "query", "schema": { "description": "Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the `wildcard` query string parameter.", "type": "string" } }, { "name": "wildcard", "description": "Enable wildcard support in the name filter.", "required": false, "in": "query", "schema": { "description": "Enable wildcard support in the name filter.", "default": false, "type": "boolean" } }, { "name": "resourceId", "description": "Show only archives that contain backups for at least one resource from the specified list.", "required": false, "in": "query", "schema": { "description": "Show only archives that contain backups for at least one resource from the specified list.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "storageType", "description": "Show a list of Archives in vaults of specified storage types.", "required": false, "in": "query", "schema": { "description": "Show a list of Archives in vaults of specified storage types.", "type": "array", "items": { "$ref": "#/components/schemas/storage_type" } } }, { "name": "type", "description": "Show a list of Archives of specified types.", "required": false, "in": "query", "schema": { "description": "Show a list of Archives of specified types.", "type": "array", "items": { "$ref": "#/components/schemas/items_4" } } }, { "name": "format", "description": "Show a list of Archives of specified formats.", "required": false, "in": "query", "schema": { "description": "Show a list of Archives of specified formats.", "type": "array", "items": { "$ref": "#/components/schemas/items_5" } } }, { "name": "backupPlanId", "description": "Show only archives created by backup plan with specified ID.", "required": false, "in": "query", "schema": { "description": "Show only archives created by backup plan with specified ID.", "type": "string", "format": "uuid" } }, { "name": "centralizedPlanId", "description": "Show only archives created by centralized plan with specified ID.", "required": false, "in": "query", "schema": { "description": "Show only archives created by centralized plan with specified ID.", "type": "string", "format": "uuid" } }, { "name": "includeCatalogInfo", "description": "Include cataloged status of archive.\n\nIf false or not specified, `cataloged_status` and `actions` fields will not\nbe included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include cataloged status of archive.\n\nIf false or not specified, `cataloged_status` and `actions` fields will not\nbe included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "forensic", "description": "Show only archives with forensic data or without forensic.\n\nIf not specified, archives are listed regardless of forensic data.\n", "required": false, "in": "query", "schema": { "description": "Show only archives with forensic data or without forensic.\n\nIf not specified, archives are listed regardless of forensic data.\n", "type": "boolean" } }, { "name": "includePrePatchManagement", "description": "Include pre-patch management status of archive.\n\nIf false or not specified, the `pre_patch_management` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include pre-patch management status of archive.\n\nIf false or not specified, the `pre_patch_management` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "prePatchManagementOnly", "description": "Show only archives with at least one backup which was made before patch management.\n\nIf false or not specified, archives are listed regardless of this filter.\n", "required": false, "in": "query", "schema": { "description": "Show only archives with at least one backup which was made before patch management.\n\nIf false or not specified, archives are listed regardless of this filter.\n", "default": false, "type": "boolean" } }, { "name": "includeMalwareFound", "description": "Include malware assessment result of backups in the archive.\n\nIf false or not specified, the `malware_found` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include malware assessment result of backups in the archive.\n\nIf false or not specified, the `malware_found` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "malwareFound", "description": "Show only archives with backups that have the specified malware status.\n\nPossible malware statuses:\n\n* notScanned - No backups were scanned in the archive.\n* clean - Backups that don't contain malware.\n* malware - Backup that contain malware.\n", "required": false, "in": "query", "schema": { "description": "Show only archives with backups that have the specified malware status.\n\nPossible malware statuses:\n\n* notScanned - No backups were scanned in the archive.\n* clean - Backups that don't contain malware.\n* malware - Backup that contain malware.\n", "type": "array", "items": { "enum": [ "notScanned", "clean", "malware" ], "type": "string" } } }, { "name": "includeOrphanage", "description": "Include orphanage status of archive.\n\nIf false or not specified, the `orphanage` object will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include orphanage status of archive.\n\nIf false or not specified, the `orphanage` object will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "orphanage.status", "description": "Filter archives by orphanage status.\n\n* NONE - Not orphaned\n* NO_POLICY - Orphaned due to missing policy\n* NO_RESOURCE - Orphaned due to missing resource\nIf not specified, archives are listed regardless of their orphanage status.\n", "required": false, "in": "query", "schema": { "description": "Filter archives by orphanage status.\n\n* NONE - Not orphaned\n* NO_POLICY - Orphaned due to missing policy\n* NO_RESOURCE - Orphaned due to missing resource\nIf not specified, archives are listed regardless of their orphanage status.\n", "type": "array", "items": { "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } }, { "name": "fromDate", "description": "Filters archives by the last updated date and time that is greater or equal to the given date and time.", "required": false, "in": "query", "schema": { "description": "Filters archives by the last updated date and time that is greater or equal to the given date and time.", "type": "string", "format": "date-time" } }, { "name": "toDate", "description": "Filters archives by the last updated date and time that is less than or equal to the given date and time.", "required": false, "in": "query", "schema": { "description": "Filters archives by the last updated date and time that is less than or equal to the given date and time.", "type": "string", "format": "date-time" } }, { "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": [ { "id": "1f8867c2-179f-ef34-159f-84279a18174d", "name": "WIN-FBM117GB12I-BACDFE64-B958-4F32-B204-2043249DBB2B-EDD63875-4641-44AA-B1A6-BACB4610AA11A", "vault_id": "885b7fe4-95ce-71fd-fff5-8de5b3cce9bb", "attributes": { "Description": "", "MachineName": "WIN-FBM117GB12I", "MarkedForDeletion": "0", "MediaIDs": "", "OwnerID": "S-1-5-18", "OwnerName": "WORKGROUP\\WIN-FBM117GB12I$", "archive3format": "1", "display-name": "WIN-FBM117GB12I - Files/folders to WIN-FBM117GB12I: C:\\local\\", "plan-id": "FF26E847-4310-0B94-2E31-375BA31C16EE", "plan-name": "Files/folders to WIN-FBM117GB12I: C:\\local\\", "resource-name": "WIN-FBM117GB12I" }, "size": 70893568, "type": "file", "format": "11", "created": "2018-02-02T01:39:24Z", "updated": "2018-02-02T01:39:24Z", "last_backup_created": "2018-02-02T01:40:05Z", "resource_type": "file", "protected_by_password": false, "encryption_algorithm": "none", "deleted": false, "file_name": "", "tenant_id": "00000000-0000-0000-0000-000000000000", "tenant_locator": "/00000000-0000-0000-0000-000000000000/", "agent_id": "45eb1623-fa48-44a6-9c35-17188781adc5", "source_key": "", "source_usn": 0, "actions": [ "refresh" ], "cataloged_status": "notIndexed", "stats": { "first_backup": "2018-01-01T12:10:00Z", "last_backup_size": 140, "last_backup_path": "test-slice-stream-name", "backup_count": 5 }, "search_index_size": 0 } ], "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": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/vault_id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/vault_id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/vault_id" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/vault_id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "delete": { "operationId": "Delete archives", "description": "Deletes archives containing selected resources.", "x-ExtJS": "VaultManager.DeleteResourceArchives", "parameters": [ { "name": "resourceId", "description": "ID of resource.", "required": true, "in": "query", "schema": { "description": "ID of resource.", "type": "string", "format": "uuid" } }, { "name": "changeTag", "description": "Tag for run tasks.", "required": true, "in": "query", "schema": { "description": "Tag for run tasks.", "type": "string" } }, { "name": "vaultId", "description": "ID of vault.", "required": false, "in": "query", "schema": { "description": "ID of vault.", "type": "string", "format": "uuid" } }, { "name": "clusterId", "description": "Limit affinity to this cluster.", "required": false, "in": "query", "schema": { "description": "Limit affinity to this cluster.", "type": "string", "format": "uuid" } }, { "name": "locationCredentialsId", "description": "ID of credentials to access vault.", "required": false, "in": "query", "schema": { "description": "ID of credentials to access vault.", "type": "string" } }, { "name": "targetAgentId", "description": "ID of the agent to execute the task.", "required": false, "in": "query", "schema": { "description": "ID of the agent to execute the task.", "type": "string" } } ], "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/archives/{archiveID}/backups": { "get": { "operationId": "Fetch archive backups", "description": "Fetches a list of backups within the archive.", "x-ExtJS": "VaultManager.ListArchiveBackups", "parameters": [ { "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": "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": "count", "description": "Show total count in the response.", "in": "query", "schema": { "description": "Show total count in the response.", "default": false, "type": "boolean" } }, { "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": "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": "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": "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": "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": "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": "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": "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": "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" } }, { "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": "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": "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": "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": "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": "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": "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": "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": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "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" } } }, { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "compacting_plan_id": { "$ref": "#/components/schemas/archive_id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "archive": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/archive_id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/archive_id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/archive_id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } }, "disks": { "description": "Disks in the Disk-image backup.", "type": "array", "items": { "title": "Disk", "description": "Disk description.", "type": "object", "additionalProperties": false, "properties": { "device_model": { "type": "string" }, "name": { "type": "string" }, "size": { "description": "Disk size in bytes.", "type": "integer" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/items_3" } } } } }, "dynamic_volumes": { "description": "Dynamic volumes in the Disk-image backup.", "type": "array", "items": { "$ref": "#/components/schemas/items_3" } }, "source_key": { "description": "Old agents sync info.", "type": "string" }, "source_usn": { "description": "Old agents sync info.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "last_seen_at": { "description": "Date and time in RFC 3339 format the backup was last seen.", "type": "string", "format": "date-time" }, "change_tag": { "description": "User-defined identifier to mark records affected by this request (obsolete).", "type": "string" }, "failover_check_info": { "title": "Failover check info", "description": "Information about status of failover.", "type": "object", "additionalProperties": false, "properties": { "error": { "description": "Failover check error.", "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "domain": { "type": "string" } } }, "is_critical_error": { "description": "True if check has failed with error that is critical for failover. False otherwise.", "type": "boolean" } } }, "triggered_by": { "description": "Reason why Backup was created.", "enum": [ "patch_management" ], "type": "string" }, "av_scanning_date": { "description": "Date and time in RFC 3339 format when backup was scanned by antivirus. Input timezone is removed by conversion to UTC", "type": "string", "format": "date-time" }, "vulnerability_assessment_result": { "description": "Vulnerability assessment result:\n* 0 - clean.\n* 1 - malicious.\n 2 - unknown.\n 3 - failed.\n* 4 - unsupported.", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "malware_assessment_result": { "description": "Malware assessment result:\n* 0 - clean.\n* 1 - malware.\n* 4 - unsupported (unsupported file system).", "enum": [ 0, 1, 4 ], "type": "integer" }, "type": { "description": "Backup type.", "enum": [ "full", "incremental", "differential", "unknown", "cdp" ], "type": "string" }, "tapes": { "$ref": "#/components/schemas/tapes_for_restore" }, "tapes_for_restore": { "$ref": "#/components/schemas/tapes_for_restore" }, "deleted_immutable": { "description": "True if the backup is marked as deleted immutable. False otherwise.", "type": "boolean" }, "validation_status": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/checksum_validation" }, "checksum_validation": { "$ref": "#/components/schemas/checksum_validation" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/checksum_validation" }, "screenshot_validation": { "$ref": "#/components/schemas/checksum_validation" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } }, "automated_test_failover_validation_status": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "$ref": "#/components/schemas/checksum_validation" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } }, "created_in_network_isolation": { "description": "True if the backup was created after network isolation. False otherwise.", "type": "boolean" } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly", "vault_manager::core_restore", "vault_manager::c2c_restore" ] } ] } }, "/vaults": { "get": { "operationId": "Fetch vaults", "description": "Fetches a list of vaults.", "x-ExtJS": "VaultManager.ListVaults", "parameters": [ { "name": "id", "description": "IDs of vaults to fetch. Multiple values can be specified by repeating the query parameter.", "required": false, "in": "query", "schema": { "description": "IDs of vaults to fetch. Multiple values can be specified by repeating the query parameter.", "type": "array", "items": { "$ref": "#/components/schemas/uuid" } } }, { "name": "storageNodeId", "description": "ID of Storage node to search vaults for.", "required": false, "in": "query", "schema": { "description": "ID of Storage node to search vaults for.", "type": "string", "format": "uuid" } }, { "name": "managed", "description": "Show only managed or unmanaged vaults.\n\nIf not specified, all types of vaults are listed.\n", "required": false, "in": "query", "schema": { "description": "Show only managed or unmanaged vaults.\n\nIf not specified, all types of vaults are listed.\n", "type": "boolean" } }, { "name": "name", "description": "Filter vaults by name. Supports matching any number of characters using asterisk wildcard character.", "required": false, "in": "query", "schema": { "description": "Filter vaults by name. Supports matching any number of characters using asterisk wildcard character.", "type": "string" } }, { "name": "hostname", "description": "Filter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.", "required": true, "in": "query", "schema": { "description": "Filter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.", "type": "string" } }, { "name": "resourceId", "description": "Show only vaults which contains archives of specified resource ID.", "required": false, "in": "query", "schema": { "description": "Show only vaults which contains archives of specified resource ID.", "type": "string", "format": "uuid" } }, { "name": "uri", "description": "Filter vaults by URI. Supports matching any number of characters using asterisk wildcard character.", "required": false, "in": "query", "schema": { "description": "Filter vaults by URI. Supports matching any number of characters using asterisk wildcard character.", "type": "string" } }, { "name": "type", "description": "Show only vaults of specified storage types.", "required": false, "in": "query", "schema": { "description": "Show only vaults of specified storage types.", "type": "array", "items": { "$ref": "#/components/schemas/storage_type" } } }, { "name": "storageId", "description": "Show only vaults in the storage with specified ID.", "required": false, "in": "query", "schema": { "description": "Show only vaults in the storage with specified ID.", "type": "string", "format": "uuid" } }, { "name": "connectionID", "description": "Show only vaults linked to Cloud Connection with specified Connection ID.", "required": false, "in": "query", "schema": { "description": "Show only vaults linked to Cloud Connection with specified Connection ID.", "type": "string" } }, { "name": "accessibleForAgent", "description": "Show only vaults that satisfy one of following conditions:\n\n1. The vault is local to the specified agent (its `storage_type` is\n `local_folder`, `cd`, `tape`, `asz` or `removable_drive` AND `managing_agent_id=accessibleForAgent`).\n1. The vault is not local to any agent (for `storage_type` that are not listed in first condition).\n", "required": false, "in": "query", "schema": { "description": "Show only vaults that satisfy one of following conditions:\n\n1. The vault is local to the specified agent (its `storage_type` is\n `local_folder`, `cd`, `tape`, `asz` or `removable_drive` AND `managing_agent_id=accessibleForAgent`).\n1. The vault is not local to any agent (for `storage_type` that are not listed in first condition).\n", "type": "string" } }, { "name": "tenantId", "description": "Show only vaults in specific Tenant ID (do not include its subtenants).", "required": false, "in": "query", "schema": { "description": "Show only vaults in specific Tenant ID (do not include its subtenants).", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "query", "description": "Show vaults that contain query string in the name or URI or hostname.", "required": false, "in": "query", "schema": { "description": "Show vaults that contain query string in the name or URI or hostname.", "type": "string" } }, { "name": "includeStats", "description": "Calculate and include vault stats.", "required": false, "in": "query", "schema": { "description": "Calculate and include vault stats.", "type": "boolean" } }, { "name": "includeStorageStats", "description": "Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "type": "boolean" } }, { "name": "includeLastBackupTime", "description": "Calculate and include vault's last backup time.", "required": false, "in": "query", "schema": { "description": "Calculate and include vault's last backup time.", "type": "boolean" } }, { "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": "includeDeleted", "description": "Whether to include vaults marked as deleted.", "required": false, "in": "query", "schema": { "description": "Whether to include vaults marked as deleted.", "type": "boolean" } }, { "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": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vault_info_page" } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "post": { "operationId": "Create or attach vault", "description": "Creates or attaches a vault.\n\nIssues corresponding commands to agents. If commands are completed successfully,\nVault Manager will store the new vault record.\n", "x-ExtJS": "VaultManager.CreateVault", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vault_create_request" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "description": "Acronis Storage Node response for task completion.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "completionResult": { "description": "Result of the task executed on Acronis Storage Node.", "type": "string" } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/refresh": { "post": { "operationId": "Refresh vaults", "description": "Sets an agent task to refresh vaults.", "x-ExtJS": "VaultManager.VaultRefresh", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vault_refresh_task" } } } }, "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "protection::readonly" ] } ] } }, "/vaults/{vaultID}": { "get": { "operationId": "Fetch vault", "description": "Fetches a vault.", "x-ExtJS": "VaultManager.GetVault", "parameters": [ { "name": "includeStats", "description": "Calculate and include vault stats.", "required": false, "in": "query", "schema": { "description": "Calculate and include vault stats.", "type": "boolean" } }, { "name": "includeStorageStats", "description": "Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include storage-side stats about vault calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "type": "boolean" } }, { "name": "includeLastBackupTime", "description": "Calculate and include vault last backup time.", "required": false, "in": "query", "schema": { "description": "Calculate and include vault last backup time.", "type": "boolean" } }, { "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": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vault_full_info" } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "delete": { "operationId": "Delete vault", "description": "Unregisters, deletes or detaches a vault.", "x-ExtJS": "VaultManager.DeleteVault", "parameters": [ { "name": "tenantID", "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "required": false, "in": "query", "schema": { "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "204": { "description": "The vault was deleted successfully.", "content": {} }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "The vault is not found.", "content": {} }, "409": { "description": "Vault update has failed because its last seen time is in the past.", "content": {} }, "500": { "description": "Any other error.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/archives": { "get": { "operationId": "Fetch vault archives", "description": "Fetches a list of vault archives.", "x-ExtJS": "VaultManager.ListVaultArchives", "parameters": [ { "name": "includeOrphanage", "description": "Include orphanage status of archive.\n\nIf false or not specified, the `orphanage` object will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include orphanage status of archive.\n\nIf false or not specified, the `orphanage` object will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "centralizedPlanId", "description": "Show only archives created by centralized plan with specified ID.", "required": false, "in": "query", "schema": { "description": "Show only archives created by centralized plan with specified ID.", "type": "string", "format": "uuid" } }, { "name": "resourceId", "description": "Show only archives that contain backups for at least one resource from the specified list.", "required": false, "in": "query", "schema": { "description": "Show only archives that contain backups for at least one resource from the specified list.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "format", "description": "Show a list of Archives of specified formats.", "required": false, "in": "query", "schema": { "description": "Show a list of Archives of specified formats.", "type": "array", "items": { "$ref": "#/components/schemas/items_5" } } }, { "name": "name", "description": "Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the `wildcard` query string parameter.", "required": false, "in": "query", "schema": { "description": "Show a list of archives of specified archive name. Supports matching any number of characters using asterisk wildcard character if it's enabled with the `wildcard` query string parameter.", "type": "string" } }, { "name": "count", "description": "Show total count in the response.", "in": "query", "schema": { "description": "Show total count in the response.", "default": false, "type": "boolean" } }, { "name": "agentId", "description": "Show a list of archives of specified agent ID.", "required": false, "in": "query", "schema": { "description": "Show a list of archives of specified agent ID.", "type": "string", "format": "uuid" } }, { "name": "wildcard", "description": "Enable wildcard support in the name filter.", "required": false, "in": "query", "schema": { "description": "Enable wildcard support in the name filter.", "default": false, "type": "boolean" } }, { "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": "forensic", "description": "Show only archives with forensic data or without forensic.\n\nIf not specified, archives are listed regardless of forensic data.\n", "required": false, "in": "query", "schema": { "description": "Show only archives with forensic data or without forensic.\n\nIf not specified, archives are listed regardless of forensic data.\n", "type": "boolean" } }, { "name": "storageType", "description": "Show a list of Archives in vaults of specified storage types.", "required": false, "in": "query", "schema": { "description": "Show a list of Archives in vaults of specified storage types.", "type": "array", "items": { "$ref": "#/components/schemas/storage_type" } } }, { "name": "orphanage.status", "description": "Filter archives by orphanage status.\n\n* NONE - Not orphaned\n* NO_POLICY - Orphaned due to missing policy\n* NO_RESOURCE - Orphaned due to missing resource\nIf not specified, archives are listed regardless of their orphanage status.\n", "required": false, "in": "query", "schema": { "description": "Filter archives by orphanage status.\n\n* NONE - Not orphaned\n* NO_POLICY - Orphaned due to missing policy\n* NO_RESOURCE - Orphaned due to missing resource\nIf not specified, archives are listed regardless of their orphanage status.\n", "type": "array", "items": { "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } }, { "name": "includeStats", "description": "Include additional information about archive.\n\nIf false or not specified, the `stats` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include additional information about archive.\n\nIf false or not specified, the `stats` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "includePrePatchManagement", "description": "Include pre-patch management status of archive.\n\nIf false or not specified, the `pre_patch_management` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include pre-patch management status of archive.\n\nIf false or not specified, the `pre_patch_management` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "showDeleted", "description": "A flag that specifies what should be added to the list of returned archives:\n\n* 1 - All deleted archives are added to the list of archives.\n* 2 - Only deleted archives marked as immutable are added to the list of archives.\n* 3 - Only deleted archives are included to the list of archives, other ones are excluded.\n* 0 - No deleted archives are added to the list of archives.\n", "required": false, "in": "query", "schema": { "description": "A flag that specifies what should be added to the list of returned archives:\n\n* 1 - All deleted archives are added to the list of archives.\n* 2 - Only deleted archives marked as immutable are added to the list of archives.\n* 3 - Only deleted archives are included to the list of archives, other ones are excluded.\n* 0 - No deleted archives are added to the list of archives.\n", "enum": [ 0, 1, 2, 3 ], "type": "integer" } }, { "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": "malwareFound", "description": "Show only archives with backups that have the specified malware status.\n\nPossible malware statuses:\n\n* notScanned - No backups were scanned in the archive.\n* clean - Backups that don't contain malware.\n* malware - Backup that contain malware.\n", "required": false, "in": "query", "schema": { "description": "Show only archives with backups that have the specified malware status.\n\nPossible malware statuses:\n\n* notScanned - No backups were scanned in the archive.\n* clean - Backups that don't contain malware.\n* malware - Backup that contain malware.\n", "type": "array", "items": { "enum": [ "notScanned", "clean", "malware" ], "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": "includeStorageStats", "description": "Include storage-side stats about archive calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include storage-side stats about archive calculated at DC and return them in the `immutable_size` field.\n\nIf false or not specified, the `immutable_size` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "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": "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" } }, { "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": "fromDate", "description": "Filters archives by the last updated date and time that is greater or equal to the given date and time.", "required": false, "in": "query", "schema": { "description": "Filters archives by the last updated date and time that is greater or equal to the given date and time.", "type": "string", "format": "date-time" } }, { "name": "backupPlanId", "description": "Show only archives created by backup plan with specified ID.", "required": false, "in": "query", "schema": { "description": "Show only archives created by backup plan with specified ID.", "type": "string", "format": "uuid" } }, { "name": "includeMalwareFound", "description": "Include malware assessment result of backups in the archive.\n\nIf false or not specified, the `malware_found` field will not be included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include malware assessment result of backups in the archive.\n\nIf false or not specified, the `malware_found` field will not be included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "toDate", "description": "Filters archives by the last updated date and time that is less than or equal to the given date and time.", "required": false, "in": "query", "schema": { "description": "Filters archives by the last updated date and time that is less than or equal to the given date and time.", "type": "string", "format": "date-time" } }, { "name": "type", "description": "Show a list of Archives of specified types.", "required": false, "in": "query", "schema": { "description": "Show a list of Archives of specified types.", "type": "array", "items": { "$ref": "#/components/schemas/items_4" } } }, { "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": "archiveId", "description": "Show a list of archives of specified archive IDs.", "required": false, "in": "query", "schema": { "description": "Show a list of archives of specified archive IDs.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "includeCatalogInfo", "description": "Include cataloged status of archive.\n\nIf false or not specified, `cataloged_status` and `actions` fields will not\nbe included in the response data.\n", "required": false, "in": "query", "schema": { "description": "Include cataloged status of archive.\n\nIf false or not specified, `cataloged_status` and `actions` fields will not\nbe included in the response data.\n", "default": false, "type": "boolean" } }, { "name": "prePatchManagementOnly", "description": "Show only archives with at least one backup which was made before patch management.\n\nIf false or not specified, archives are listed regardless of this filter.\n", "required": false, "in": "query", "schema": { "description": "Show only archives with at least one backup which was made before patch management.\n\nIf false or not specified, archives are listed regardless of this filter.\n", "default": false, "type": "boolean" } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "schema": { "example": { "items": [ { "id": "1f8867c2-179f-ef34-159f-84279a18174d", "name": "WIN-FBM117GB12I-BACDFE64-B958-4F32-B204-2043249DBB2B-EDD63875-4641-44AA-B1A6-BACB4610AA11A", "vault_id": "885b7fe4-95ce-71fd-fff5-8de5b3cce9bb", "attributes": { "Description": "", "MachineName": "WIN-FBM117GB12I", "MarkedForDeletion": "0", "MediaIDs": "", "OwnerID": "S-1-5-18", "OwnerName": "WORKGROUP\\WIN-FBM117GB12I$", "archive3format": "1", "display-name": "WIN-FBM117GB12I - Files/folders to WIN-FBM117GB12I: C:\\local\\", "plan-id": "FF26E847-4310-0B94-2E31-375BA31C16EE", "plan-name": "Files/folders to WIN-FBM117GB12I: C:\\local\\", "resource-name": "WIN-FBM117GB12I" }, "size": 70893568, "type": "file", "format": "11", "created": "2018-02-02T01:39:24Z", "updated": "2018-02-02T01:39:24Z", "last_backup_created": "2018-02-02T01:40:05Z", "resource_type": "file", "protected_by_password": false, "encryption_algorithm": "none", "deleted": false, "file_name": "", "tenant_id": "00000000-0000-0000-0000-000000000000", "tenant_locator": "/00000000-0000-0000-0000-000000000000/", "agent_id": "45eb1623-fa48-44a6-9c35-17188781adc5", "source_key": "", "source_usn": 0, "actions": [ "refresh" ], "cataloged_status": "notIndexed", "stats": { "first_backup": "2018-01-01T12:10:00Z", "last_backup_size": 140, "last_backup_path": "test-slice-stream-name", "backup_count": 5 }, "search_index_size": 0 } ], "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": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/vault_id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/vault_id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/vault_id" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/vault_id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "delete": { "operationId": "Delete vault archives", "description": "Deletes specified archives from the vault.", "x-ExtJS": "VaultManager.DeleteVaultArchives", "parameters": [ { "name": "clusterId", "description": "Limit affinity to this cluster.", "required": false, "in": "query", "schema": { "description": "Limit affinity to this cluster.", "type": "string", "format": "uuid" } }, { "name": "locationCredentialsId", "description": "ID of credentials to access vault.", "required": false, "in": "query", "schema": { "description": "ID of credentials to access vault.", "type": "string" } }, { "name": "targetAgentId", "description": "ID of the agent to execute the task.", "required": false, "in": "query", "schema": { "description": "ID of the agent to execute the task.", "type": "string" } }, { "name": "changeTag", "description": "Tag for run tasks.", "required": true, "in": "query", "schema": { "description": "Tag for run tasks.", "type": "string" } }, { "name": "archiveId", "description": "ID of archive.", "required": true, "in": "query", "schema": { "description": "ID of archive.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/archives/refresh": { "post": { "operationId": "Refresh vault archives", "description": "Sets an agent task to refresh specified vault archives.", "x-ExtJS": "VaultManager.ArchiveRefresh", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archive_refresh_task" } } } }, "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}": { "get": { "operationId": "Fetch vault archive backup", "description": "Fetches a backup from the vault archive.", "x-ExtJS": "VaultManager.GetBackup", "parameters": [ { "name": "showDeleted", "description": "A flag that specifies if the backup must be returned:\n\n* 1 - All backups belonging to alive, deleted or immutable archives are taken into account.\n* 2 - (Default) Only backups belonging to alive or immutable are returned.\n* 3 - Only backup belonging to deleted archives are returned.\n* 0 - Backups belonging to deleted or immutable archives are not returned.\n", "required": false, "in": "query", "schema": { "description": "A flag that specifies if the backup must be returned:\n\n* 1 - All backups belonging to alive, deleted or immutable archives are taken into account.\n* 2 - (Default) Only backups belonging to alive or immutable are returned.\n* 3 - Only backup belonging to deleted archives are returned.\n* 0 - Backups belonging to deleted or immutable archives are not returned.\n", "enum": [ 0, 1, 2, 3 ], "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": [ "validation_status", "automated_test_failover_validation_status" ], "type": "string" } } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "schema": { "description": "Backup description.", "example": { "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" ] }, "type": "object", "additionalProperties": false, "required": [ "vault_id", "archive_id", "backup_id", "type" ], "properties": { "vault_id": { "$ref": "#/components/schemas/archive_id_6" }, "archive_id": { "$ref": "#/components/schemas/archive_id_6" }, "backup_id": { "$ref": "#/components/schemas/archive_id_6" }, "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_7" }, "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_6" }, "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_6" }, "storage_type": { "$ref": "#/components/schemas/storage_type_8" }, "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_8" }, "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" } } }, { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_7" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "compacting_plan_id": { "$ref": "#/components/schemas/archive_id_6" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "archive": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/archive_id_6" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/archive_id_6" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_7" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/archive_id_6" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } }, "disks": { "description": "Disks in the Disk-image backup.", "type": "array", "items": { "title": "Disk", "description": "Disk description.", "type": "object", "additionalProperties": false, "properties": { "device_model": { "type": "string" }, "name": { "type": "string" }, "size": { "description": "Disk size in bytes.", "type": "integer" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/items_9" } } } } }, "dynamic_volumes": { "description": "Dynamic volumes in the Disk-image backup.", "type": "array", "items": { "$ref": "#/components/schemas/items_9" } }, "source_key": { "description": "Old agents sync info.", "type": "string" }, "source_usn": { "description": "Old agents sync info.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "last_seen_at": { "description": "Date and time in RFC 3339 format the backup was last seen.", "type": "string", "format": "date-time" }, "change_tag": { "description": "User-defined identifier to mark records affected by this request (obsolete).", "type": "string" }, "failover_check_info": { "title": "Failover check info", "description": "Information about status of failover.", "type": "object", "additionalProperties": false, "properties": { "error": { "description": "Failover check error.", "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "domain": { "type": "string" } } }, "is_critical_error": { "description": "True if check has failed with error that is critical for failover. False otherwise.", "type": "boolean" } } }, "triggered_by": { "description": "Reason why Backup was created.", "enum": [ "patch_management" ], "type": "string" }, "av_scanning_date": { "description": "Date and time in RFC 3339 format when backup was scanned by antivirus. Input timezone is removed by conversion to UTC", "type": "string", "format": "date-time" }, "vulnerability_assessment_result": { "description": "Vulnerability assessment result:\n* 0 - clean.\n* 1 - malicious.\n 2 - unknown.\n 3 - failed.\n* 4 - unsupported.", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "malware_assessment_result": { "description": "Malware assessment result:\n* 0 - clean.\n* 1 - malware.\n* 4 - unsupported (unsupported file system).", "enum": [ 0, 1, 4 ], "type": "integer" }, "type": { "description": "Backup type.", "enum": [ "full", "incremental", "differential", "unknown", "cdp" ], "type": "string" }, "tapes": { "$ref": "#/components/schemas/tapes_for_restore_10" }, "tapes_for_restore": { "$ref": "#/components/schemas/tapes_for_restore_10" }, "deleted_immutable": { "description": "True if the backup is marked as deleted immutable. False otherwise.", "type": "boolean" }, "validation_status": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/checksum_validation_11" }, "checksum_validation": { "$ref": "#/components/schemas/checksum_validation_11" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/checksum_validation_11" }, "screenshot_validation": { "$ref": "#/components/schemas/checksum_validation_11" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } }, "automated_test_failover_validation_status": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "$ref": "#/components/schemas/checksum_validation_11" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } }, "created_in_network_isolation": { "description": "True if the backup was created after network isolation. False otherwise.", "type": "boolean" } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "The backup not found or excluded by showDeleted parameter.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status": { "put": { "operationId": "Set vault archive backup validation status", "description": "Sets the validation status for backup in the vault archive. Writes the result of backup validation plan.", "x-ExtJS": "VaultManager.AddBackupValidationStatus", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Create backup validation status request", "description": "Backup Validation Status description.", "anyOf": [ { "type": "object", "required": [ "checksum_validation" ], "properties": { "checksum_validation": {} } }, { "type": "object", "required": [ "vm_heartbeat_validation" ], "properties": { "vm_heartbeat_validation": {} } }, { "type": "object", "required": [ "screenshot_validation" ], "properties": { "screenshot_validation": {} } } ], "type": "object", "additionalProperties": false, "properties": { "checksum_validation": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "screenshot_validation": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } } } } }, "responses": { "200": { "description": "The validation status for backup was updated successfully.", "content": { "application/json": { "schema": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "checksum_validation": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "screenshot_validation": { "$ref": "#/components/schemas/vm_heartbeat_validation" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_full": { "get": { "operationId": "Fetch full vault archive backup screenshot", "description": "Fetches the validated full screenshot of a backup in the vault archive.", "x-ExtJS": "VaultManager.GetValidatedScreenshotFull", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "303": { "description": "Redirect to full screenshot download link.", "content": {} }, "404": { "description": "The backup not found or no screenshots for the backup.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_preview": { "get": { "operationId": "Fetch vault archive backup screenshot preview", "description": "Fetches the validated screenshot preview of a backup in the vault archive.", "x-ExtJS": "VaultManager.GetValidatedScreenshotPreview", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "303": { "description": "Redirect to screenshot preview download link.", "content": {} }, "404": { "description": "The backup not found or no screenshots for the backup.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status": { "put": { "operationId": "Add ATF validation status", "description": "Adds Automated Test Failover Validation (ATF) status for backup. Write result of backup validation plan.", "x-ExtJS": "VaultManager.BackupAutomatedTestFailoverValidationStatus", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "description": "Value of backup validation status.", "enum": [ "SUCCESS", "FAILURE", "CANCELLED" ], "type": "string" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } } } } }, "responses": { "204": { "description": "The Automated Test Failover Validation status for backup was added successfully.", "content": {} }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_full": { "get": { "operationId": "Fetch full screenshot", "description": "Fetches validated full screenshot for backup.", "x-ExtJS": "VaultManager.GetValidatedATFScreenshotFull", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "303": { "description": "Redirect to full automated test failover screenshot download link.", "content": {} }, "404": { "description": "The backup not found or no screenshots for the backup.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_preview": { "get": { "operationId": "Fetch screenshot preview", "description": "Fetches validated screenshot preview for backup.", "x-ExtJS": "VaultManager.GetValidatedATFScreenshotPreview", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "303": { "description": "Redirect to automated test failover screenshot preview download link.", "content": {} }, "404": { "description": "The backup not found or no screenshots for the backup.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backup_timestamps": { "get": { "operationId": "Fetch vault archive backup timestamps", "description": "Fetches a list of timestamps when the backups were made. By default, groups backups by 24 hours.", "x-ExtJS": "VaultManager.ListArchiveDates", "parameters": [ { "name": "resourceId", "description": "Show timestamps only for specified resource.", "required": false, "in": "query", "schema": { "description": "Show timestamps only for specified resource.", "type": "string", "format": "uuid" } }, { "name": "count", "description": "Show total count in the response.", "in": "query", "schema": { "description": "Show total count in the response.", "default": false, "type": "boolean" } }, { "name": "tzOffset", "description": "Timezone difference from current timezone to UTC in minutes.", "required": false, "in": "query", "schema": { "description": "Timezone difference from current timezone to UTC in minutes.", "default": 0, "type": "integer" } }, { "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": "showDeleted", "description": "A flag that specifies what kind of deleted backups should participate in timestamps calculation:\n\n* 1 - All deleted backups are participating in calculation.\n* 2 - Only deleted backups marked as immutable are participating in calculation.\n* 0 - No deleted backups are participating in calculation.\n", "required": false, "in": "query", "schema": { "description": "A flag that specifies what kind of deleted backups should participate in timestamps calculation:\n\n* 1 - All deleted backups are participating in calculation.\n* 2 - Only deleted backups marked as immutable are participating in calculation.\n* 0 - No deleted backups are participating in calculation.\n", "enum": [ 0, 1, 2 ], "type": "integer" } }, { "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": "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": "granularity", "description": "Granularity interval of grouped backups in seconds.", "required": false, "in": "query", "schema": { "description": "Granularity interval of grouped backups in seconds.", "default": 86400, "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": "created", "description": "Show backups created only within specified time range.", "required": false, "in": "query", "schema": { "description": "Show backups created only within specified time range.", "type": "array", "items": { "$ref": "#/components/schemas/datetime_fn" } } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "schema": { "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": { "description": "List of date and time entries in RFC 3339 format.", "type": "array", "items": { "type": "string", "format": "date-time" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups": { "get": { "operationId": "Fetch vault archive backups", "description": "Fetches a list of vault archive backups.", "x-ExtJS": "VaultManager.ListVaultArchiveBackups", "parameters": [ { "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": "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": "count", "description": "Show total count in the response.", "in": "query", "schema": { "description": "Show total count in the response.", "default": false, "type": "boolean" } }, { "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": "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": "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": "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": "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": "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": "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": "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": "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" } }, { "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": "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": "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": "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": "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": "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": "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": "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": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "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" } } }, { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "compacting_plan_id": { "$ref": "#/components/schemas/archive_id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "archive": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/archive_id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/archive_id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/archive_id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } }, "disks": { "description": "Disks in the Disk-image backup.", "type": "array", "items": { "title": "Disk", "description": "Disk description.", "type": "object", "additionalProperties": false, "properties": { "device_model": { "type": "string" }, "name": { "type": "string" }, "size": { "description": "Disk size in bytes.", "type": "integer" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/items_3" } } } } }, "dynamic_volumes": { "description": "Dynamic volumes in the Disk-image backup.", "type": "array", "items": { "$ref": "#/components/schemas/items_3" } }, "source_key": { "description": "Old agents sync info.", "type": "string" }, "source_usn": { "description": "Old agents sync info.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "last_seen_at": { "description": "Date and time in RFC 3339 format the backup was last seen.", "type": "string", "format": "date-time" }, "change_tag": { "description": "User-defined identifier to mark records affected by this request (obsolete).", "type": "string" }, "failover_check_info": { "title": "Failover check info", "description": "Information about status of failover.", "type": "object", "additionalProperties": false, "properties": { "error": { "description": "Failover check error.", "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "domain": { "type": "string" } } }, "is_critical_error": { "description": "True if check has failed with error that is critical for failover. False otherwise.", "type": "boolean" } } }, "triggered_by": { "description": "Reason why Backup was created.", "enum": [ "patch_management" ], "type": "string" }, "av_scanning_date": { "description": "Date and time in RFC 3339 format when backup was scanned by antivirus. Input timezone is removed by conversion to UTC", "type": "string", "format": "date-time" }, "vulnerability_assessment_result": { "description": "Vulnerability assessment result:\n* 0 - clean.\n* 1 - malicious.\n 2 - unknown.\n 3 - failed.\n* 4 - unsupported.", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "malware_assessment_result": { "description": "Malware assessment result:\n* 0 - clean.\n* 1 - malware.\n* 4 - unsupported (unsupported file system).", "enum": [ 0, 1, 4 ], "type": "integer" }, "type": { "description": "Backup type.", "enum": [ "full", "incremental", "differential", "unknown", "cdp" ], "type": "string" }, "tapes": { "$ref": "#/components/schemas/tapes_for_restore" }, "tapes_for_restore": { "$ref": "#/components/schemas/tapes_for_restore" }, "deleted_immutable": { "description": "True if the backup is marked as deleted immutable. False otherwise.", "type": "boolean" }, "validation_status": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/checksum_validation" }, "checksum_validation": { "$ref": "#/components/schemas/checksum_validation" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/checksum_validation" }, "screenshot_validation": { "$ref": "#/components/schemas/checksum_validation" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } }, "automated_test_failover_validation_status": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "$ref": "#/components/schemas/checksum_validation" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } }, "created_in_network_isolation": { "description": "True if the backup was created after network isolation. False otherwise.", "type": "boolean" } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly", "vault_manager::core_restore", "vault_manager::c2c_restore" ] } ] }, "delete": { "operationId": "Delete vault archive backups_0", "description": "Deletes vault archive backups.", "x-ExtJS": "VaultManager.DeleteArchiveBackups", "parameters": [ { "name": "backupId", "description": "IDs of backups.", "required": true, "in": "query", "schema": { "description": "IDs of backups.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "tenantId", "description": "Tenant ID to reduce the scope.", "required": false, "in": "query", "schema": { "description": "Tenant ID to reduce the scope.", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "changeTag", "description": "Tag for run tasks.", "required": true, "in": "query", "schema": { "description": "Tag for run tasks.", "type": "string" } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/backups/delete": { "post": { "operationId": "Delete vault archive backups_1", "description": "Sets the backup deletion tasks to appropriate agent.", "x-ExtJS": "VaultManager.PostBackupDeleteTask", "parameters": [ { "name": "backupID", "description": "Backup ID to delete.", "required": false, "in": "query", "schema": { "description": "Backup ID to delete.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "tenantId", "description": "Tenant ID to reduce the scope.", "required": false, "in": "query", "schema": { "description": "Tenant ID to reduce the scope.", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "changeTag", "description": "Tag for run tasks.", "required": false, "in": "query", "schema": { "description": "Tag for run tasks.", "type": "string" } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Backup delete task.", "type": "object", "additionalProperties": false, "properties": { "password": { "description": "Archive password.", "type": "string" }, "location_credentials_id": { "description": "Credentials ID of location credentials.", "type": "string" }, "archive_credentials_id": { "description": "Credentials ID of archive password.", "type": "string" }, "target_agent_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } } } } }, "responses": { "200": { "description": "List of task IDs created.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "items": { "description": "List of Tasks identifiers.", "type": "array", "items": { "type": "string" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/archives/{archiveID}/replication_status": { "get": { "operationId": "Fetch archive geo-replication status", "description": "Fetches archive geo-replication status.", "x-ExtJS": "VaultManager.GetArchiveReplicationStatus", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "schema": { "example": { "status": "off", "error": { "code": 0, "message": "" } }, "type": "object", "additionalProperties": false, "properties": { "status": { "description": "Current replication status.", "enum": [ "off", "inprogress", "completed", "error" ], "type": "string" }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "description": "Acronis Backup Gateway error code.", "type": "integer" }, "message": { "description": "Description of the error.", "type": "string" } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/config": { "get": { "operationId": "Fetch vault configuration", "description": "Fetches the vault configuration.", "x-ExtJS": "VaultManager.GetVaultConfig", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vault" } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "patch": { "operationId": "Update vault configuration", "description": "Updates the vault configuration.", "x-ExtJS": "VaultManager.UpdateVaultConfig", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Update Vault Configuration", "description": "Update Fields in Vault Configuration.", "example": { "name": "Vault1", "access_address": "10.25.60.81", "hostname": "MY-PC", "settings": { "comment": "comment here", "catalog_uri": "E:\\test1\\" } }, "type": "object", "additionalProperties": false, "properties": { "name": { "description": "Name of the vault.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "settings": { "type": "object", "additionalProperties": false, "properties": { "comment": { "type": "string" }, "catalog_uri": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Success in case of Acronis Storage Node (ASN) vault.", "content": { "application/json": { "schema": {} } } }, "204": { "description": "Success in case of not Acronis Storage Node (ASN) vault.", "content": {} }, "404": { "description": "The vault is not found.", "content": {} }, "409": { "description": "Update of the vault has failed because its last seen time is in the past.", "content": {} }, "500": { "description": "Any other error.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/stats": { "get": { "operationId": "Fetch vault statistics", "description": "Fetches the vault statistics.", "x-ExtJS": "VaultManager.GetVaultStats", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "Vault stats", "description": "Vault statistics.", "example": { "archive_count": 2, "backup_count": 25, "backed_up_data_size": 339214336, "original_data_size": 53691285504, "occupied_data_size": 339214336, "immutable_size": 6432517, "free_space": 483221569536, "total_space": 500000000000 }, "type": "object", "additionalProperties": false, "properties": { "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backup_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "logical_archive_size": { "description": "Logical archive size sum.", "type": "integer" }, "deduplication_stats": { "type": "object", "additionalProperties": false, "properties": { "occupied_deduplication_db_size": { "description": "Amount of space deduplication database takes up.", "type": "integer" }, "free_deduplication_db_size": { "description": "Amount of space left on storage where deduplication database is.", "type": "integer" }, "occupied_deduplication_ds_size": { "description": "Amount of space datastore takes up.", "type": "integer" }, "occupied_deduplication_ram": { "description": "Amount of RAM deduplication database takes up.", "type": "integer" }, "free_deduplication_ram": { "description": "Amount of free RAM that is left for deduplication database to use.", "type": "integer" }, "deduplication_index_usage": { "description": "Load factor of deduplication database.", "type": "string" }, "data_to_index_size": { "description": "Amount of data that needs to be indexed (LDS size).", "type": "integer" } } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "post": { "operationId": "Update vault statistics", "description": "Updates the vault statistics.", "x-ExtJS": "VaultManager.SetVaultStats", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Vault stats", "description": "Vault statistics.", "type": "object", "additionalProperties": false, "properties": { "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backup_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "logical_archive_size": { "description": "Logical archive size sum.", "type": "integer" }, "deduplication_stats": { "type": "object", "additionalProperties": false, "properties": { "occupied_deduplication_db_size": { "description": "Amount of space deduplication database takes up.", "type": "integer" }, "free_deduplication_db_size": { "description": "Amount of space left on storage where deduplication database is.", "type": "integer" }, "occupied_deduplication_ds_size": { "description": "Amount of space datastore takes up.", "type": "integer" }, "occupied_deduplication_ram": { "description": "Amount of RAM deduplication database takes up.", "type": "integer" }, "free_deduplication_ram": { "description": "Amount of free RAM that is left for deduplication database to use.", "type": "integer" }, "deduplication_index_usage": { "description": "Load factor of deduplication database.", "type": "string" }, "data_to_index_size": { "description": "Amount of data that needs to be indexed (LDS size).", "type": "integer" } } } } } } } }, "responses": { "204": { "description": "Vault statistics were updated successfully.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/agents": { "get": { "operationId": "Fetch vault agents", "description": "Fetches a list of agents managing the vault.", "x-ExtJS": "VaultManager.ListAgents", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "agents": { "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/vaults/{vaultID}/change_password": { "post": { "operationId": "Change encrypted vault password", "description": "Available in on-premises version only.\n\nChange password for the encrypted vault.\n", "x-ExtJS": "VaultManager.ChangePassword", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Change password for encrypted vaults", "description": "Request to change password of encrypted vaults.", "type": "object", "additionalProperties": false, "required": [ "session_id", "uri_old", "uri_new" ], "properties": { "session_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "uri_old": { "description": "URI for old password.", "type": "string" }, "uri_new": { "description": "URI for new password.", "type": "string" } } } } } }, "responses": { "204": { "description": "The vault password was updated successfully.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/change_credentials": { "post": { "operationId": "Change vault credentials", "description": "Available in on-premises version only.\n\nChange credentials for the managed vault.\n", "x-ExtJS": "VaultManager.ChangeVaultCredentials", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Change credential for managed vaults", "description": "Request to change credentials of managed vaults.", "type": "object", "additionalProperties": false, "required": [ "session_id", "uri" ], "properties": { "session_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "uri": { "description": "URI for credentials.", "type": "string" } } } } } }, "responses": { "204": { "description": "The vault credentials were changed successfully.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/vaults/{vaultID}/replace_vault_password": { "post": { "operationId": "Replace encrypted vault password", "description": "Available in on-premises version only.\n\nReplaces the password of an encrypted vault.\n", "x-ExtJS": "VaultManager.ReplaceVaultPassword", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Replace password in encrypted vaults request", "description": "Request to check password of encrypted vault and replace it if necessary.", "type": "object", "additionalProperties": false, "required": [ "session_id", "uri" ], "properties": { "session_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "uri": { "description": "URI for password.", "type": "string" } } } } } }, "responses": { "204": { "description": "The vault password was replaced successfully.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/archives": { "get": { "operationId": "Fetch archives sync info", "description": "Fetches the archives sync information.", "x-ExtJS": "VaultManager.ListArchivesSyncInfo", "parameters": [ { "name": "agentId", "description": "Filter archives by agent ID.", "required": false, "in": "query", "schema": { "description": "Filter archives by agent ID.", "type": "string", "format": "uuid" } }, { "name": "sourceUsnGt", "description": "Show only archives with source Update Sequence Number (USN) greater than requested.", "required": false, "in": "query", "schema": { "description": "Show only archives with source Update Sequence Number (USN) greater than requested.", "type": "integer" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "integer" } }, { "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": "", "content": { "application/json": { "schema": { "description": "Archive sync info list.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "source_key": { "type": "string" }, "source_usn": { "type": "integer" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "post": { "operationId": "Update archives batch", "description": "Updates a batch of archives.", "x-ExtJS": "VaultManager.UpdateArchivesBulk", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to update archives set.", "type": "object", "additionalProperties": false, "properties": { "vault": { "description": "Properties with the request-wide effect when `full_resync` or `last_batch` is true. Ignored otherwise.", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/id_12" }, "last_seen_at": { "description": "Allows to update `last_seen_at` value in archive and backup objects that are deleted by this request. `last_seen_at` is updated if this property is not null both in the request and in the existing archive object and the request contains more recent `last_seen_at` than the value in the archive object.", "type": "string", "format": "date-time" } } }, "add": { "description": "List of archives that should be created.", "type": "array", "items": { "allOf": [ { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/id_12" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/id_12" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/id_12" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/id_12" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } }, { "type": "object", "required": [ "vault_id", "archive_id" ], "properties": { "vault_id": {}, "archive_id": {} } } ] } }, "delete": { "description": "Specifies archives that should be deleted.", "type": "object", "additionalProperties": false, "properties": { "change_tag": { "description": "User-defined tag of operation.", "type": "string" }, "ids": { "description": "List of archives that should be deleted.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } } } }, "full_resync": { "description": "Specifies the full re-sync mode. If true, `add` array will be treated like a full and only full list of vault archives. Other archives will be marked as deletable and if not added again they will be deleted at the end of the session.", "type": "boolean" }, "last_batch": { "description": "Specifies that it is the last batch. If true, the session started with full_resync for the same vault will be closed, so non-added archives will be deleted.", "type": "boolean" } } } } } }, "responses": { "200": { "description": "Multiple operations have taken over archives with successful status\nfor each archive can be viewed in the body of the response.\n", "content": { "application/json": { "schema": { "description": "Archive batch update result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "IDs of created archives.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } }, "updated": { "description": "IDs of updated archives.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } }, "errors": { "description": "List of errors per archive that encountered during batch operation execution.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } }, "207": { "description": "Multiple operations have taken over archives with different status\nfor each archive can be viewed in the body of the response.\n", "content": { "application/json": { "schema": { "description": "Archive batch update result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "IDs of created archives.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } }, "updated": { "description": "IDs of updated archives.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } }, "errors": { "description": "List of errors per archive that encountered during batch operation execution.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } }, "404": { "description": "The involved archives/vaults have not been found.", "content": { "application/json": { "schema": { "description": "Archive batch update result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "IDs of created archives.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } }, "updated": { "description": "IDs of updated archives.", "type": "array", "items": { "$ref": "#/components/schemas/items_13" } }, "errors": { "description": "List of errors per archive that encountered during batch operation execution.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/backups": { "get": { "operationId": "Fetch backups sync info", "description": "Fetches the backups sync information.", "x-ExtJS": "VaultManager.ListBackupsSyncInfo", "parameters": [ { "name": "agentId", "description": "Filter archives by agent ID.", "required": false, "in": "query", "schema": { "description": "Filter archives by agent ID.", "type": "string", "format": "uuid" } }, { "name": "sourceUsnGt", "description": "Show only archives with source Update Sequence Number (USN) greater than requested.", "required": false, "in": "query", "schema": { "description": "Show only archives with source Update Sequence Number (USN) greater than requested.", "type": "integer" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "integer" } }, { "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": "", "content": { "application/json": { "schema": { "description": "Backup sync info list.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "source_key": { "type": "string" }, "source_usn": { "type": "integer" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "post": { "operationId": "Update backups batch", "description": "Updates a batch of backups.", "x-ExtJS": "VaultManager.UpdateBackupsBulk", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to update backups set.", "anyOf": [ { "oneOf": [ { "type": "object", "required": [ "full_resync", "vault_id", "archive_id", "add" ], "properties": { "full_resync": { "enum": [ true ] }, "vault_id": {}, "archive_id": {}, "add": {} } }, { "type": "object", "required": [ "full_resync", "add" ], "properties": { "full_resync": { "enum": [ true ] }, "add": {} } }, { "type": "object", "required": [ "add" ], "properties": { "add": {} } } ] }, { "type": "object", "required": [ "patch" ], "properties": { "patch": {} } }, { "type": "object", "required": [ "delete" ], "properties": { "delete": {} } } ], "type": "object", "additionalProperties": false, "properties": { "add": { "description": "List of backups that should be created.", "type": "array", "items": { "allOf": [ { "description": "Backup creation request.", "allOf": [ { "$ref": "#/components/schemas/item0" }, { "type": "object", "required": [ "change_tag", "created", "size" ], "properties": { "change_tag": { "description": "Tag to identify creation task.", "type": "string" }, "archive_credentials_id": { "description": "Archive credentials ID.", "type": "string" }, "created": {}, "size": {} } } ] }, { "type": "object", "required": [ "vault_id", "archive_id", "backup_id" ], "properties": { "vault_id": {}, "archive_id": {}, "backup_id": {} } } ] } }, "patch": { "description": "List of backups that should be patched. For non-existent backups, errors will be returned.", "type": "array", "items": { "allOf": [ { "description": "Backup updating request, modified partial version of the Backup. Identified by `vault_id`, `archive_id` and `backup_id`.", "allOf": [ { "$ref": "#/components/schemas/item0" }, { "type": "object", "properties": { "archive_credentials_id": { "description": "Archive credentials ID.", "type": "string" } } } ], "type": "object" }, { "type": "object", "required": [ "vault_id", "archive_id", "backup_id" ], "properties": { "vault_id": {}, "archive_id": {}, "backup_id": {} } } ] } }, "delete": { "description": "Specifies backups that should be deleted.", "type": "object", "additionalProperties": false, "properties": { "change_tag": { "description": "User-defined tag of operation.", "type": "string" }, "ids": { "description": "List of backups that should be deleted.", "type": "array", "items": { "$ref": "#/components/schemas/items_14" } } } }, "full_resync": { "description": "Specifies the full re-sync mode. If true, `add` array will be treated like a full and only full list of archive backups.", "type": "boolean" }, "vault_id": { "$ref": "#/components/schemas/archive_id_15" }, "archive_id": { "$ref": "#/components/schemas/archive_id_15" } } } } } }, "responses": { "200": { "description": "Multiple operations have taken over backups with successful status for each backup\ncan be viewed in the body of the response.\n", "content": { "application/json": { "schema": { "description": "Backup batch update result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "IDs of created backups.", "type": "array", "items": { "$ref": "#/components/schemas/items_14" } }, "errors": { "description": "List of errors per backup that encountered during batch operation execution.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } }, "207": { "description": "Multiple operations have taken over backups with different status for each backup\ncan be viewed in the body of the response.\n", "content": { "application/json": { "schema": { "description": "Backup batch update result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "IDs of created backups.", "type": "array", "items": { "$ref": "#/components/schemas/items_14" } }, "errors": { "description": "List of errors per backup that encountered during batch operation execution.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } }, "404": { "description": "The involved archives/vaults/backups have not been found.", "content": { "application/json": { "schema": { "description": "Backup batch update result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "IDs of created backups.", "type": "array", "items": { "$ref": "#/components/schemas/items_14" } }, "errors": { "description": "List of errors per backup that encountered during batch operation execution.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults": { "get": { "operationId": "Fetch vaults sync info", "description": "Fetches the vaults sync information.", "x-ExtJS": "VaultManager.ListVaultsSyncInfo", "parameters": [ { "name": "managingAgentId", "description": "Filter vaults by agent ID.", "required": false, "in": "query", "schema": { "description": "Filter vaults by agent ID.", "type": "string", "format": "uuid" } }, { "name": "sourceUsnGt", "description": "Show only vaults with source Update Sequence Number (USN) greater than requested.", "required": false, "in": "query", "schema": { "description": "Show only vaults with source Update Sequence Number (USN) greater than requested.", "type": "integer" } }, { "name": "limit", "required": false, "in": "query", "schema": { "type": "integer" } }, { "name": "before", "description": "Base64-encoded token obtained from the previous response.\nPoints to the end of the page.\n", "required": false, "in": "query", "schema": { "description": "Base64-encoded token obtained from the previous response.\nPoints to the end of the page.\n", "type": "string" } }, { "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": "", "content": { "application/json": { "schema": { "description": "Vault sync info list.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "source_key": { "type": "string" }, "source_usn": { "type": "integer" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "post": { "operationId": "Add vaults batch", "description": "Adds a batch of vaults.", "x-ExtJS": "VaultManager.AddVaultsBulk", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Vault info.", "type": "object", "additionalProperties": false, "required": [ "config" ], "properties": { "config": { "title": "Vault description", "description": "Vault description.", "type": "object", "additionalProperties": false, "required": [ "name", "version", "storage_type", "settings" ], "properties": { "id": { "$ref": "#/components/schemas/managing_agent_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/managing_agent_id" }, "storage_type": { "$ref": "#/components/schemas/storage_type_16" }, "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_16" }, "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" } } }, { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/managing_agent_id" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "compacting_plan_id": { "$ref": "#/components/schemas/managing_agent_id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "stats": { "title": "Vault stats", "description": "Vault statistics.", "type": "object", "additionalProperties": false, "properties": { "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backup_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "logical_archive_size": { "description": "Logical archive size sum.", "type": "integer" }, "deduplication_stats": { "type": "object", "additionalProperties": false, "properties": { "occupied_deduplication_db_size": { "description": "Amount of space deduplication database takes up.", "type": "integer" }, "free_deduplication_db_size": { "description": "Amount of space left on storage where deduplication database is.", "type": "integer" }, "occupied_deduplication_ds_size": { "description": "Amount of space datastore takes up.", "type": "integer" }, "occupied_deduplication_ram": { "description": "Amount of RAM deduplication database takes up.", "type": "integer" }, "free_deduplication_ram": { "description": "Amount of free RAM that is left for deduplication database to use.", "type": "integer" }, "deduplication_index_usage": { "description": "Load factor of deduplication database.", "type": "string" }, "data_to_index_size": { "description": "Amount of data that needs to be indexed (LDS size).", "type": "integer" } } } } }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/managing_agent_id" } }, "status": { "type": "object" } } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "description": "Batch vault creation result.", "type": "object", "additionalProperties": false, "properties": { "created": { "description": "List of IDs of created vaults.", "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "vault_id" ], "properties": { "vault_id": { "$ref": "#/components/schemas/managing_agent_id" } } } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/error" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults/{vaultID}": { "put": { "operationId": "Register or update vault", "description": "Registers or updates a vault.", "x-ExtJS": "VaultManager.RegisterVault", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vault_info" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } } } }, "400": { "description": "Invalid request.", "content": {} }, "409": { "description": "Conflict on object update.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] }, "delete": { "operationId": "Soft delete vault", "description": "Marks the vault as deleted in the Vault Manager database.", "x-ExtJS": "VaultManager.MarkVaultDeleted", "parameters": [ { "name": "tenantID", "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "required": false, "in": "query", "schema": { "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "204": { "description": "The vault was soft deleted successfully.", "content": {} }, "404": { "description": "The vault is not found.", "content": {} }, "409": { "description": "Update of the vault has failed because its last seen time is in the past.", "content": {} }, "500": { "description": "Any other error.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults/{vaultID}/agents": { "post": { "operationId": "Bind agents to vault", "description": "Binds agents to the vault.", "x-ExtJS": "VaultManager.BindAgents", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to bind agents to a vault.", "type": "object", "additionalProperties": false, "properties": { "agent_ids": { "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults/{vaultID}/index_catalog_status": { "post": { "operationId": "Update vault index catalog status", "description": "Updates the index catalog status of vault.", "x-ExtJS": "VaultManager.UpdateIndexCatalogStatus", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to update index catalog status.", "type": "object", "additionalProperties": false, "properties": { "catalog_index_result": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "archive_id": { "$ref": "#/components/schemas/items_17" }, "indexed_backup_ids": { "type": "array", "items": { "$ref": "#/components/schemas/items_17" } }, "is_delete_archive": { "type": "boolean" } } } } } } } } }, "responses": { "204": { "description": "The vault index catalog status was updated successfully.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults/{vaultID}/stats": { "patch": { "operationId": "Update vault stats", "description": "Updates the specified fields of vault stats.", "x-ExtJS": "VaultManager.UpdateVaultStats", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Vault stats", "description": "Vault statistics.", "example": { "archive_count": 2, "backup_count": 25, "backed_up_data_size": 339214336, "original_data_size": 53691285504, "occupied_data_size": 339214336, "immutable_size": 6432517, "free_space": 483221569536, "total_space": 500000000000 }, "type": "object", "additionalProperties": false, "properties": { "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backup_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "logical_archive_size": { "description": "Logical archive size sum.", "type": "integer" }, "deduplication_stats": { "type": "object", "additionalProperties": false, "properties": { "occupied_deduplication_db_size": { "description": "Amount of space deduplication database takes up.", "type": "integer" }, "free_deduplication_db_size": { "description": "Amount of space left on storage where deduplication database is.", "type": "integer" }, "occupied_deduplication_ds_size": { "description": "Amount of space datastore takes up.", "type": "integer" }, "occupied_deduplication_ram": { "description": "Amount of RAM deduplication database takes up.", "type": "integer" }, "free_deduplication_ram": { "description": "Amount of free RAM that is left for deduplication database to use.", "type": "integer" }, "deduplication_index_usage": { "description": "Load factor of deduplication database.", "type": "string" }, "data_to_index_size": { "description": "Amount of data that needs to be indexed (LDS size).", "type": "integer" } } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults/{vaultID}/archives/{archiveID}": { "put": { "operationId": "Add archive to vault", "description": "Adds an archive to the vault.", "x-ExtJS": "VaultManager.AddArchive", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archive" } } } }, "responses": { "201": { "description": "The archive was successfully added to the vault.", "content": {} }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] }, "patch": { "operationId": "Update archive", "description": "Updates an archive in the vault.", "x-ExtJS": "VaultManager.UpdateArchive", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archive" } } } }, "responses": { "204": { "description": "Ok, no content.", "content": {} }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] }, "delete": { "operationId": "Soft delete archive", "description": "Marks the archive as deleted in the Vault Manager database.", "x-ExtJS": "VaultManager.DeleteArchive", "parameters": [ { "name": "last_seen_at", "description": "Date and time in RFC 3339 when the archive was last seen.", "required": false, "in": "query", "schema": { "description": "Date and time in RFC 3339 when the archive was last seen.", "type": "string", "format": "date-time" } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The archive was soft deleted successfully.", "content": {} }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}": { "put": { "operationId": "Add backup", "description": "Adds a new backup to the vault archive.", "x-ExtJS": "VaultManager.AddBackup", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backup_create_request" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] }, "patch": { "operationId": "Update backup", "description": "Updates a backup in the vault archive.", "x-ExtJS": "VaultManager.UpdateBackup", "parameters": [ { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backup_update_request" } } } }, "responses": { "204": { "description": "", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] }, "delete": { "operationId": "Soft delete backup", "description": "Marks the backup as deleted in the Vault Manager database.", "x-ExtJS": "VaultManager.DeleteBackup", "parameters": [ { "name": "tenantId", "description": "Tenant ID to reduce the scope.", "required": false, "in": "query", "schema": { "description": "Tenant ID to reduce the scope.", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "changeTag", "description": "Change tag.", "required": false, "in": "query", "schema": { "description": "Change tag.", "type": "string" } }, { "name": "last_seen_at", "description": "Date and time in RFC 3339 when the backup was last seen.", "required": false, "in": "query", "schema": { "description": "Date and time in RFC 3339 when the backup was last seen.", "type": "string", "format": "date-time" } }, { "name": "archive_credentials_id", "description": "Archive credentials ID.", "required": false, "in": "query", "schema": { "description": "Archive credentials ID.", "type": "string" } }, { "name": "vaultID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "archiveID", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "backupID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "204": { "description": "The backup was soft deleted successfully.", "content": {} }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/agents/{agentID}": { "delete": { "operationId": "Delete agent", "description": "Deletes an agent.", "x-ExtJS": "VaultManager.RemoveAgent", "parameters": [ { "name": "agentID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/sync/storage_nodes": { "post": { "operationId": "Register storage node_0", "description": "Available in on-premises version only.\n\nRegisters a new storage node.\n", "x-ExtJS": "VaultManager.SyncASN", "parameters": [ { "name": "tenantID", "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "required": false, "in": "query", "schema": { "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage_node_extended" } } } }, "responses": { "201": { "description": "Storage node was successfully registered.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/stats": { "get": { "operationId": "Fetch archive stats", "description": "Fetches statistics for archives that meet the specified conditions.", "x-ExtJS": "VaultManager.GetStats", "parameters": [ { "name": "resourceID", "description": "Get statistics only for Archives that contain backups for specified resources.", "required": false, "in": "query", "schema": { "description": "Get statistics only for Archives that contain backups for specified resources.", "type": "array", "items": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" } } }, { "name": "storageType", "description": "Get statistics only for Archives in vaults of specified storage types.", "required": false, "in": "query", "schema": { "description": "Get statistics only for Archives in vaults of specified storage types.", "type": "array", "items": { "$ref": "#/components/schemas/storage_type" } } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "Stats", "description": "Statistics for Archives.", "example": { "occupied_data_size": 420125145 }, "type": "object", "additionalProperties": false, "properties": { "occupied_data_size": { "description": "Amount of space that archives occupy on storage.", "type": "integer" }, "search_index_size": { "description": "Total search index size.", "type": "integer" } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/storage_nodes": { "get": { "operationId": "Fetch registered storage nodes", "description": "Available in on-premises version only.\n\nFetches a list of all registered storage nodes.\n", "x-ExtJS": "VaultManager.ListASN", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Storage node", "description": "Storage node description.", "type": "object", "additionalProperties": false, "required": [ "name", "machine_id" ], "properties": { "id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "machine_id": { "description": "Identifier of the machine with Storage node. Currently hostname or IP address.", "type": "string" }, "status": { "description": "Status of the machine.", "type": "string" }, "addresses": { "description": "Addresses of the machine.", "type": "array", "items": { "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "type": "string" } }, "tenant_locator": { "type": "string" }, "memory_size": { "description": "Memory size of the machine.", "type": "integer" }, "processor_frequency": { "description": "Processor frequency of the machine.", "type": "integer" }, "processor_name": { "description": "Processor name of the machine.", "type": "string" }, "operating_system_name": { "description": "Operating system name of the machine.", "type": "string" }, "architecture": { "description": "Architecture of the machine.", "type": "string" }, "agent_version": { "description": "Agent version installed in the machine.", "type": "string" }, "vault_count": { "description": "Number of managed vaults.", "type": "integer" } } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] }, "post": { "operationId": "Register storage node_1", "description": "Available in on-premises version only.\n\nRegisters a new storage node.\n", "x-ExtJS": "VaultManager.RegisterASN", "requestBody": { "content": { "application/json": { "schema": { "title": "Storage node registration", "description": "Storage node registration description.", "type": "object", "additionalProperties": false, "required": [ "host" ], "properties": { "host": { "description": "IP address of the machine with storage node.", "type": "string" }, "username": { "description": "Credentials.", "type": "string" }, "password": { "description": "Credentials.", "type": "string" } } } } } }, "responses": { "201": { "description": "Storage node was successfully registered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } } } }, "400": { "description": "Invalid request.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/storage_nodes/{storageNodeID}/checkuser": { "post": { "operationId": "Check user access", "description": "Available in on-premises version only.\n\nChecks whether the provided user credentials can access the storage node.\n", "x-ExtJS": "VaultManager.ValidateAgentCreds", "parameters": [ { "name": "storageNodeID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validate_credentials" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "Acronis Storage Node response for task completion.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "completionResult": { "description": "Result of the task executed on Acronis Storage Node.", "type": "string" } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/storage_nodes/{storageNodeID}/check_location": { "post": { "operationId": "Find vault by path", "description": "Available in on-premises version only.\n\nAttempts to find a vault by the provided path.\n", "x-ExtJS": "VaultManager.CheckLocation", "parameters": [ { "name": "storageNodeID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/find_location" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "Acronis Storage Node response for find location request.", "type": "object", "additionalProperties": false, "properties": { "checkLocationResult": { "type": "object", "additionalProperties": false, "properties": { "conclusion": { "type": "string" }, "vault_config": { "type": "object" } } }, "uri": { "type": "string" } } } } } }, "400": { "description": "Invalid request.", "content": {} }, "404": { "description": "Resource not found.", "content": {} }, "500": { "description": "Internal error occurred.", "content": {} } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/abgw_storages/{storageID}": { "delete": { "operationId": "Unregister storage", "description": "Available in on-premises version only.\n\nUnregisters the storage from account server and detach all its vaults.\n", "x-ExtJS": "VaultManager.UnregisterStorage", "parameters": [ { "name": "last_seen_at", "description": "Date and time in RFC 3339 when the storage was last seen.", "required": false, "in": "query", "schema": { "description": "Date and time in RFC 3339 when the storage was last seen.", "type": "string", "format": "date-time" } }, { "name": "tenantID", "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "required": false, "in": "query", "schema": { "description": "Tenant ID (where the vault will be removed from) to separate the target tenant from the effective one", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] } }, { "name": "storageID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": {} } } } }, "security": [ { "oauth2": [ "infra_admin" ] } ] } }, "/storage_dirs/{storageID}": { "get": { "operationId": "Fetch storage folders", "description": "Available in on-premises version only.\n\nFetches a list of top level storage folders.\n\nDetached folders are always listed.\nAttached folders listed depending on the `includeAttached` parameter value.\n", "x-ExtJS": "VaultManager.ListStorageTopDirs", "parameters": [ { "name": "includeAttached", "description": "List all folders including attached to vaults.", "required": false, "in": "query", "schema": { "description": "List all folders including attached to vaults.", "default": false, "type": "boolean" } }, { "name": "storageID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Storage dir", "description": "Storage dir description.", "type": "object", "additionalProperties": false, "required": [ "name", "path" ], "properties": { "name": { "type": "string" }, "path": { "type": "string" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/storage_dirs/{storageID}/{path}": { "get": { "operationId": "Fetch storage folders in path", "description": "Available in on-premises version only.\n\nFetches a list of storage folders in path. Detached folders are always listed.\n\nAttached folders listed depending on the `includeAttached` parameter value.\n", "x-ExtJS": "VaultManager.ListStorageDirs", "parameters": [ { "name": "includeAttached", "description": "List all folders including the ones attached to vaults.", "required": false, "in": "query", "schema": { "description": "List all folders including the ones attached to vaults.", "default": false, "type": "boolean" } }, { "name": "storageID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/uuid" } }, { "name": "path", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Storage dir", "description": "Storage dir description.", "type": "object", "additionalProperties": false, "required": [ "name", "path" ], "properties": { "name": { "type": "string" }, "path": { "type": "string" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } }, "/healthcheck": { "get": { "operationId": "Health check", "description": "Health check route. Returns basic information about service.", "responses": { "200": { "description": "" } }, "security": [ { "oauth2": [] } ] } }, "/search_index_size_stats/{tenantID}": { "get": { "operationId": "Fetch archive search index size stats", "description": "Fetches a list of archives and their search index sizes for the tenant.", "x-ExtJS": "VaultManager.SearchIndexSize", "parameters": [ { "name": "archive_name", "description": "Archive Name.", "required": false, "in": "query", "schema": { "description": "Archive Name.", "type": "string" } }, { "name": "tenantID", "required": true, "in": "path", "schema": { "$ref": "#/components/schemas/tenant_id_18" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "archive_name", "instance_id", "index_size" ], "properties": { "archive_name": { "description": "Name of the archive.", "type": "string" }, "instance_id": { "description": "ID of the instance which resource stored at.", "type": "string" }, "index_size": { "description": "Size of search index.", "type": "integer" } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/storage_usage_stats": { "get": { "operationId": "Fetch storage usage stats", "description": "Fetches the storage usage counters per tenant.", "x-ExtJS": "VaultManager.StorageUsageItems", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "title": "Storage usage items", "description": "Cloud and local storage counters.", "type": "object", "additionalProperties": false, "properties": { "items": { "description": "Cloud and local storage counters calculated per tenant.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tenant": { "description": "Tenant identifier.", "type": "string" }, "amazon_s3_storage_usage": { "description": "Amazon S3 storage usage.", "type": "integer" }, "amazon_s3_archive_count": { "description": "Number of archives stored in Amazon S3 storage.", "type": "integer" }, "s3_compatible_storage_usage": { "description": "S3-compatible storages usage.", "type": "integer" }, "s3_compatible_archive_count": { "description": "Number of archives stored in S3-compatible storages.", "type": "integer" }, "microsoft_azure_storage_usage": { "description": "Microsoft Azure storage usage.", "type": "integer" }, "microsoft_azure_archive_count": { "description": "Number of archives stored in Microsoft Azure storage.", "type": "integer" }, "cloud_storage_usage": { "description": "Cloud storage usage.", "type": "integer" }, "cloud_archive_count": { "description": "Number of archives stored in Cloud storage.", "type": "integer" }, "local_storage_usage": { "description": "Local storage usage, counted as sum of usages by all local storage types (local folder, network folder, NFS folder, Secure Zone).", "type": "integer" }, "local_storage_size": { "description": "Total local storage size.", "type": "integer" }, "local_archive_count": { "description": "Number of archives stored in local storages.", "type": "integer" } } } } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin" ] } ] } }, "/antimalware_scan_stats": { "get": { "operationId": "Fetch antimalware scan stats", "description": "Fetches the antimalware backup scan counters.", "x-ExtJS": "VaultManager.AntiMalwareScanStats", "parameters": [ { "name": "created", "description": "Show backups created only within specified time range.", "required": false, "in": "query", "schema": { "description": "Show backups created only within specified time range.", "type": "array", "items": { "$ref": "#/components/schemas/datetime_fn" } } }, { "name": "archive_type", "description": "Show only backups of specified archive types.", "required": false, "in": "query", "schema": { "description": "Show only backups of specified archive types.", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "Statistics of scanned backups for anti malware matter.", "type": "object", "additionalProperties": false, "properties": { "clean_count": { "description": "Number of clean recovery points.", "type": "integer" }, "infected_count": { "description": "Number of infected recovery points.", "type": "integer" }, "not_supported_clean_count": { "description": "Number of clean recovery points with unsupported partitions.", "type": "integer" } } } } } } }, "security": [ { "oauth2": [ "vault_manager::system_admin", "vault_manager::admin", "vault_manager::read", "protection::readonly" ] } ] } } }, "x-roles": [ { "name": "public", "id": "1", "description": "public role", "x-tags": [ "public" ] }, { "name": "private", "id": "2", "description": "private role", "x-tags": [ "private" ] } ], "components": { "schemas": { "datetime_fn": { "description": "A filter by date and time in RFC 3339 format with the support\nfor comparison operators.\n\nAvailable operators:\n\n* `lt` - less than\n* `gt` - greater than\n* `le` - less than or equals\n* `ge` - greater than or equals\n", "type": "string" }, "storage_type": { "description": "Vault storage type.", "enum": [ "unknown", "local_folder", "network_share", "ftp", "sftp", "cd", "tape", "storage_server", "asz", "removable_drive", "online", "nfs_share", "esx", "local_abgw", "microsoft_azure", "amazon_s3", "s3_compatible" ], "type": "string" }, "items": { "description": "Backup type.", "enum": [ "full", "incremental", "differential", "unknown", "cdp" ], "type": "string" }, "items_1": { "description": "Reason why Backup was created.", "enum": [ "patch_management" ], "type": "string" }, "archive_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "tenant_id": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/archive_id" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "storage_type_2": { "description": "Vault storage type.", "enum": [ "unknown", "local_folder", "network_share", "ftp", "sftp", "cd", "tape", "storage_server", "asz", "removable_drive", "online", "nfs_share", "esx", "local_abgw", "microsoft_azure", "amazon_s3", "s3_compatible" ], "type": "string" }, "items_3": { "title": "Volume", "description": "Volume description.", "type": "object", "additionalProperties": false, "properties": { "free_space": { "description": "Free volume space in bytes.", "type": "integer" }, "is_bootable": { "type": "boolean" }, "is_system": { "type": "boolean" }, "name": { "type": "string" }, "size": { "description": "Volume size in bytes.", "type": "integer" }, "mount_strid": { "description": "String identifier of the volume.", "type": "string" } } }, "tapes_for_restore": { "type": "array", "items": { "$ref": "#/components/schemas/archive_id" } }, "checksum_validation": { "description": "Value of backup validation status.", "enum": [ "SUCCESS", "FAILURE", "CANCELLED" ], "type": "string" }, "items_4": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "items_5": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "vault_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "uuid": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "item1": { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" }, "vault_info_page": { "example": { "items": [ { "access_address": "", "actions": [ "Delete", "Refresh" ], "archive_count": 0, "backed_up_data_size": 0, "backups_count": 0, "free_space": 25097170944, "hostname": "MY-PC", "id": "885b7fe4-95ce-71fd-fff5-8de5b3cce9bb", "last_backup_time": "2018-02-02T01:40:05Z", "managing_agent_id": "45eb1623-fa48-44a6-9c35-17188781adc5", "name": "C:/local/", "occupied_data_size": 0, "immutable_size": 0, "original_data_size": 0, "settings": { "catalog_uri": null, "comment": null }, "status": { "status": "ok", "status_error": "{}\n" }, "storage_type": "local_folder", "tenant_id": "00000000-0000-0000-0000-000000000000", "tenant_locator": "/00000000-0000-0000-0000-000000000000/", "total_space": 42580570112, "uri": "C:/local/", "version": "LOCATION_VERSION_ABR12", "storage_uri": "C:/local/" }, { "access_address": "WIN-FBM117GB12I", "actions": [ "Delete", "Refresh", "Detach" ], "archive_count": 0, "backed_up_data_size": 0, "backups_count": 0, "free_space": 25912774656, "hostname": "WIN-FBM117GB12I", "id": "e93071d1-9081-4cd6-bd38-537631080257", "managing_agent_id": "44b300fe-bf4c-49ba-be65-d6346baaad3a", "name": "simple", "occupied_data_size": 3178496, "immutable_size": 0, "original_data_size": 0, "settings": { "catalog_type": "CATALOG_TYPE_DISABLED", "catalog_uri": "", "comment": "", "storage_type": "local_folder" }, "status": { "status": "ok", "status_error": "{}\n" }, "storage_type": "storage_server", "tenant_id": "00000000-0000-0000-0000-000000000000", "tenant_locator": "/00000000-0000-0000-0000-000000000000/", "total_space": 42580570112, "uri": "bsp://WIN-FBM117GB12I/simple#arl:/44B300FE-BF4C-49BA-BE65-D6346BAAAD3A/E93071D1-9081-4CD6-BD38-537631080257", "version": "LOCATION_VERSION_ABR11_7", "storage_uri": "C:\\work\\vault\\" } ], "paging": { "cursors": { "before": "eyJfdXJsUGF0aCI6WyIvYXBpL3ZhdWx0X21hbmFnZXIvdjEvdmF1bHRzIl0sIm9mZnNldCI6WyIwIl19" } } }, "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": { "title": "Vault full info", "description": "Full info about the vault.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "storage_uri", "storage_type" ], "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "description": "Name of the vault.", "type": "string" }, "uri": { "description": "URI of the vault.", "type": "string" }, "storage_uri": { "description": "URI of the storage.", "type": "string" }, "version": { "description": "Version of the vault.", "enum": [ "LOCATION_VERSION_ABR10", "LOCATION_VERSION_ABR11", "LOCATION_VERSION_ABR11_7", "LOCATION_VERSION_ABR12" ], "type": "string" }, "managing_agent_id": { "$ref": "#/components/schemas/id" }, "storage_type": { "$ref": "#/components/schemas/storage_type" }, "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.", "anyOf": [ { "$ref": "#/components/schemas/item0_19" }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backups_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "compacting_plan_id": { "$ref": "#/components/schemas/id" }, "access_address": { "$ref": "#/components/schemas/access_address" }, "last_backup_time": { "description": "Date and time in RFC 3339 format when last backup was created.", "type": "string", "format": "date-time" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" } } } } } }, "vault_create_request": { "description": "Request to add new vault.", "type": "object", "additionalProperties": false, "required": [ "action", "config" ], "properties": { "action": { "description": "Specifies how to add new vault: on attach and create corresponding commands will be issued to agent.", "enum": [ "attach", "create" ], "type": "string" }, "config": { "$ref": "#/components/schemas/config" }, "credentials_id": { "description": "ID of credentials to access vault.", "type": "string" }, "protected_storage": { "$ref": "#/components/schemas/protected_storage" } } }, "vault_refresh_task": { "description": "Vault refresh task.", "oneOf": [ { "type": "object", "required": [ "level", "vault_ids" ], "properties": { "level": {}, "vault_ids": {} } }, { "type": "object", "required": [ "resources", "level" ], "properties": { "resources": {}, "level": {} } } ], "example": { "vault_ids": [ "1eb86058-bff3-183f-3033-442c1b61aba1" ], "level": "archive", "include_immutable": false, "target_agent_id": "B489DE2E-3AC0-421F-BB07-6A28880896B5", "location_credentials_id": "bdc753ee-56ec-2905-d2b4-cd469da1a49f@location!383" }, "type": "object", "additionalProperties": false, "properties": { "vault_ids": { "type": "array", "items": { "$ref": "#/components/schemas/id" } }, "level": { "description": "Refresh level.", "enum": [ "archive", "backup", "backup_content" ], "type": "string" }, "resources": { "type": "array", "items": { "description": "ID of resources to refresh.", "type": "string" } }, "task_tag": { "description": "Tag to identify the task.", "type": "string" }, "include_immutable": { "description": "When true, show deleted immutable backups.", "type": "boolean" }, "target_agent_id": { "$ref": "#/components/schemas/id" }, "location_credentials_id": { "description": "ID of credentials to access vault.", "type": "string" } } }, "vault_full_info": { "title": "Vault full info", "description": "Full info about the vault.", "example": { "access_address": "", "actions": [ "Delete", "Refresh" ], "archive_count": 0, "backed_up_data_size": 0, "backups_count": 0, "free_space": 25097170944, "hostname": "MY-PC", "id": "885b7fe4-95ce-71fd-fff5-8de5b3cce9bb", "last_backup_time": "2018-02-02T01:40:05Z", "managing_agent_id": "45eb1623-fa48-44a6-9c35-17188781adc5", "name": "C:/local/", "occupied_data_size": 0, "immutable_size": 0, "original_data_size": 0, "settings": { "catalog_uri": null, "comment": null }, "status": { "status": "ok", "status_error": "{}\n" }, "storage_type": "local_folder", "tenant_id": "00000000-0000-0000-0000-000000000000", "tenant_locator": "/00000000-0000-0000-0000-000000000000/", "total_space": 42580570112, "uri": "C:/local/", "version": "LOCATION_VERSION_ABR12", "storage_uri": "C:/local/" }, "type": "object", "additionalProperties": false, "required": [ "id", "name", "storage_uri", "storage_type" ], "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "description": "Name of the vault.", "type": "string" }, "uri": { "description": "URI of the vault.", "type": "string" }, "storage_uri": { "description": "URI of the storage.", "type": "string" }, "version": { "description": "Version of the vault.", "enum": [ "LOCATION_VERSION_ABR10", "LOCATION_VERSION_ABR11", "LOCATION_VERSION_ABR11_7", "LOCATION_VERSION_ABR12" ], "type": "string" }, "managing_agent_id": { "$ref": "#/components/schemas/id" }, "storage_type": { "$ref": "#/components/schemas/storage_type" }, "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.", "anyOf": [ { "$ref": "#/components/schemas/item0_19" }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backups_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "compacting_plan_id": { "$ref": "#/components/schemas/id" }, "access_address": { "$ref": "#/components/schemas/access_address" }, "last_backup_time": { "description": "Date and time in RFC 3339 format when last backup was created.", "type": "string", "format": "date-time" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" } } }, "archive_refresh_task": { "description": "Archive refresh task.", "example": { "archive_ids": [ "bdc753ee-56ec-2905-d2b4-cd469da1a49f" ], "level": "backup", "include_immutable": false, "archive_credentials_id": "bdc753ee-56ec-2905-d2b4-cd469da1a49f@archive!383", "location_credentials_id": "bdc753ee-56ec-2905-d2b4-cd469da1a49f@location!383", "target_agent_id": "B489DE2E-3AC0-421F-BB07-6A28880896B5" }, "type": "object", "additionalProperties": false, "required": [ "archive_ids" ], "properties": { "archive_ids": { "$ref": "#/components/schemas/tapes" }, "level": { "description": "Refresh level.", "enum": [ "archive", "backup", "backup_content" ], "type": "string" }, "task_tag": { "description": "Tag that identifies the task.", "type": "string" }, "include_immutable": { "description": "If true, shows deleted immutable backups. False otherwise.", "type": "boolean" }, "target_agent_id": { "$ref": "#/components/schemas/id" }, "location_credentials_id": { "description": "Credentials ID of location credentials.", "type": "string" }, "archive_credentials_id": { "description": "Credentials ID of archive password.", "type": "string" } } }, "archive_id_6": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "tenant_id_7": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/archive_id_6" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "storage_type_8": { "description": "Vault storage type.", "enum": [ "unknown", "local_folder", "network_share", "ftp", "sftp", "cd", "tape", "storage_server", "asz", "removable_drive", "online", "nfs_share", "esx", "local_abgw", "microsoft_azure", "amazon_s3", "s3_compatible" ], "type": "string" }, "items_9": { "title": "Volume", "description": "Volume description.", "type": "object", "additionalProperties": false, "properties": { "free_space": { "description": "Free volume space in bytes.", "type": "integer" }, "is_bootable": { "type": "boolean" }, "is_system": { "type": "boolean" }, "name": { "type": "string" }, "size": { "description": "Volume size in bytes.", "type": "integer" }, "mount_strid": { "description": "String identifier of the volume.", "type": "string" } } }, "tapes_for_restore_10": { "type": "array", "items": { "$ref": "#/components/schemas/archive_id_6" } }, "checksum_validation_11": { "description": "Value of backup validation status.", "enum": [ "SUCCESS", "FAILURE", "CANCELLED" ], "type": "string" }, "vm_heartbeat_validation": { "description": "Value of backup validation status.", "enum": [ "SUCCESS", "FAILURE", "CANCELLED" ], "type": "string" }, "vault": { "title": "Vault description", "description": "Vault description.", "example": { "id": "819ffb32-df46-4fe8-a8bf-e366bbe15900", "name": "weekly", "version": "LOCATION_VERSION_ABR11_7", "storage_type": "network_share", "settings": { "storage_uri": "//share/vaults/weekly" } }, "type": "object", "additionalProperties": false, "required": [ "name", "version", "storage_type", "settings" ], "properties": { "id": { "$ref": "#/components/schemas/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/id" }, "storage_type": { "$ref": "#/components/schemas/storage_type" }, "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": [ { "$ref": "#/components/schemas/item0_19" }, { "$ref": "#/components/schemas/item1_21" }, { "$ref": "#/components/schemas/item2" }, { "$ref": "#/components/schemas/item3" }, { "$ref": "#/components/schemas/item4" }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "$ref": "#/components/schemas/access_address" }, "compacting_plan_id": { "$ref": "#/components/schemas/id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "id_12": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "items_13": { "description": "Composite archive ID that includes vault ID.", "type": "object", "additionalProperties": false, "required": [ "vault_id", "archive_id" ], "properties": { "vault_id": { "$ref": "#/components/schemas/id_12" }, "archive_id": { "$ref": "#/components/schemas/id_12" } } }, "error": { "description": "Base error object.", "type": "object", "additionalProperties": false, "required": [ "domain", "reason" ], "properties": { "domain": { "description": "Error type or category.", "type": "string" }, "reason": { "description": "Error ID or code.", "type": "string" }, "context": { "description": "Error context dictionary.", "type": "object" }, "serCode": { "type": "string" }, "kbLink": { "type": "string" }, "hints": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "name", "href" ], "properties": { "name": { "type": "string" }, "href": { "type": "string" } } } }, "debug": { "description": "Error debug information.", "type": "object", "additionalProperties": false, "properties": { "msg": { "type": "string" }, "stackTrace": { "type": "string" } } } } }, "item0": { "description": "Backup description.", "type": "object", "additionalProperties": false, "required": [ "vault_id", "archive_id", "backup_id", "type" ], "properties": { "vault_id": { "$ref": "#/components/schemas/archive_id_15" }, "archive_id": { "$ref": "#/components/schemas/archive_id_15" }, "backup_id": { "$ref": "#/components/schemas/archive_id_15" }, "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_22" }, "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_15" }, "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_15" }, "storage_type": { "$ref": "#/components/schemas/storage_type_23" }, "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_23" }, "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" } } }, { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_22" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "compacting_plan_id": { "$ref": "#/components/schemas/archive_id_15" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "archive": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/archive_id_15" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/archive_id_15" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "description": "Archive type.", "enum": [ "unknown", "file", "image", "vss_application", "msexchange", "msexchange_doc", "mssql", "oracle", "ad", "empty" ], "type": "string" }, "format": { "description": "Format of archive.", "enum": [ "11", "12", "alwaysIncremental" ], "type": "string" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_22" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/archive_id_15" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } } } }, "disks": { "description": "Disks in the Disk-image backup.", "type": "array", "items": { "title": "Disk", "description": "Disk description.", "type": "object", "additionalProperties": false, "properties": { "device_model": { "type": "string" }, "name": { "type": "string" }, "size": { "description": "Disk size in bytes.", "type": "integer" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/items_24" } } } } }, "dynamic_volumes": { "description": "Dynamic volumes in the Disk-image backup.", "type": "array", "items": { "$ref": "#/components/schemas/items_24" } }, "source_key": { "description": "Old agents sync info.", "type": "string" }, "source_usn": { "description": "Old agents sync info.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "last_seen_at": { "description": "Date and time in RFC 3339 format the backup was last seen.", "type": "string", "format": "date-time" }, "change_tag": { "description": "User-defined identifier to mark records affected by this request (obsolete).", "type": "string" }, "failover_check_info": { "title": "Failover check info", "description": "Information about status of failover.", "type": "object", "additionalProperties": false, "properties": { "error": { "description": "Failover check error.", "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "domain": { "type": "string" } } }, "is_critical_error": { "description": "True if check has failed with error that is critical for failover. False otherwise.", "type": "boolean" } } }, "triggered_by": { "description": "Reason why Backup was created.", "enum": [ "patch_management" ], "type": "string" }, "av_scanning_date": { "description": "Date and time in RFC 3339 format when backup was scanned by antivirus. Input timezone is removed by conversion to UTC", "type": "string", "format": "date-time" }, "vulnerability_assessment_result": { "description": "Vulnerability assessment result:\n* 0 - clean.\n* 1 - malicious.\n 2 - unknown.\n 3 - failed.\n* 4 - unsupported.", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "malware_assessment_result": { "description": "Malware assessment result:\n* 0 - clean.\n* 1 - malware.\n* 4 - unsupported (unsupported file system).", "enum": [ 0, 1, 4 ], "type": "integer" }, "type": { "description": "Backup type.", "enum": [ "full", "incremental", "differential", "unknown", "cdp" ], "type": "string" }, "tapes": { "$ref": "#/components/schemas/tapes_for_restore_25" }, "tapes_for_restore": { "$ref": "#/components/schemas/tapes_for_restore_25" }, "deleted_immutable": { "description": "True if the backup is marked as deleted immutable. False otherwise.", "type": "boolean" }, "validation_status": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/checksum_validation_26" }, "checksum_validation": { "$ref": "#/components/schemas/checksum_validation_26" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/checksum_validation_26" }, "screenshot_validation": { "$ref": "#/components/schemas/checksum_validation_26" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } }, "automated_test_failover_validation_status": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "$ref": "#/components/schemas/checksum_validation_26" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } }, "created_in_network_isolation": { "description": "True if the backup was created after network isolation. False otherwise.", "type": "boolean" } } }, "items_14": { "description": "Composite backup ID that includes vault and archive ID. Tenant ID has meaning in case where vault ID is not unique.", "type": "object", "additionalProperties": false, "required": [ "vault_id", "archive_id", "backup_id" ], "properties": { "vault_id": { "$ref": "#/components/schemas/archive_id_15" }, "archive_id": { "$ref": "#/components/schemas/archive_id_15" }, "backup_id": { "$ref": "#/components/schemas/archive_id_15" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_22" }, "archive_credentials_id": { "type": "string" } } }, "archive_id_15": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "managing_agent_id": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "storage_type_16": { "description": "Vault storage type.", "enum": [ "unknown", "local_folder", "network_share", "ftp", "sftp", "cd", "tape", "storage_server", "asz", "removable_drive", "online", "nfs_share", "esx", "local_abgw", "microsoft_azure", "amazon_s3", "s3_compatible" ], "type": "string" }, "vault_info": { "description": "Vault info.", "example": { "config": { "name": "WIN-FBM117GB12I: C:\\\\test\\\\", "settings": { "storage_uri": "C:/test/" }, "is_full_config": true, "uri": "C:/test/", "tenant_locator": "/00000000-0000-0000-0000-000000000000/", "storage_type": "local_folder", "version": "LOCATION_VERSION_ABR12", "managing_agent_id": "45EB1623-FA48-44A6-9C35-17188781ADC5", "id": "A574AB3E-DB44-2C60-01A9-FB9CFBA89D43" }, "stats": { "free_space": 26164383744, "total_space": 42580570112 }, "status": { "status": "ok", "status_error": "{}\\n" }, "agents": [ "45EB1623-FA48-44A6-9C35-17188781ADC5" ] }, "type": "object", "additionalProperties": false, "required": [ "config" ], "properties": { "config": { "$ref": "#/components/schemas/config" }, "stats": { "$ref": "#/components/schemas/stats" }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/id" } }, "status": { "type": "object" } } }, "id_response": { "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/id" } } }, "items_17": { "description": "Universally unique identifier.", "type": "string", "format": "uuid" }, "archive": { "title": "Archive", "description": "Archive description.", "example": { "id": "21057332-3588-4363-a0d1-c00b5757593c", "name": "b2af49a9-f2b3-470b-a827-614bdf817a8e", "vault_id": "00000000-0000-0000-0000-000000000000", "attributes": { "archive-id": "21057332-3588-4363-A0D1-C00B5757593C", "backup_count": 57, "cluster_id": "", "cluster_name": "", "compressed_dataSize": 0, "data_size": 4531466240, "deduplicated_size": 4531466240, "description": "", "display_name": "Linux primary - New backup plan", "forIndexing_dataSize": 0, "initial-seeding-verified": "0", "machine_id": "D7198861-C9EA-4AFC-8C1E-5513E23D8D58", "machine_name": "BCA-msk7-7725-failover-c7b3623d-fee9-4025-a068-3a5265d4f906", "original_dataSize": 267268243456, "owner_id": "security-posix-uid-0", "owner_name": "root", "plan_id": "00000000-0000-0000-0000-000000000000", "plan_name": "", "resource_name": "", "storage-uri": "avfs:/online?account%3d137%26authProtoVersion%3d1%26computer%3d1%26provider%3dAcronis", "uri": "avfs:/online?account%3d137%26authProtoVersion%3d1%26computer%3d1%26provider%3dAcronis#arl:/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000/21057332-3588-4363-A0D1-C00B5757593C?archive_name%3db2af49a9-f2b3-470b-a827-614bdf817a8e", "{DD212122-6CA8-4CFE-9CA9-DE586882C979}": "0", "{EC4C7738-9F4B-4F1C-9ED0-E29CD70C3AED}": "0" }, "size": 2254254080, "type": "image", "created": "2017-10-04T09:05:21Z", "updated": "0001-01-01T00:00:00Z", "last_backup_created": "2017-10-12T08:01:48Z", "resource_type": "vmwesx", "protected_by_password": false, "deleted": false, "file_name": "", "tenant_id": "65", "tenant_locator": "/1/65/", "agent_id": "bec6091d-de3f-4d5b-a042-22ee65fce812", "source_key": "", "source_usn": 0, "actions": [ "refresh" ], "cataloged_status": "notIndexed", "pds_status": "archiveNotReady", "search_index_size": 0, "format": "11" }, "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "$ref": "#/components/schemas/items_4" }, "format": { "$ref": "#/components/schemas/items_5" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "$ref": "#/components/schemas/stats_27" }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "$ref": "#/components/schemas/orphanage" } } }, "backup_create_request": { "description": "Backup creation request.", "allOf": [ { "$ref": "#/components/schemas/item0_28" }, { "type": "object", "required": [ "change_tag", "created", "size" ], "properties": { "change_tag": { "description": "Tag to identify creation task.", "type": "string" }, "archive_credentials_id": { "description": "Archive credentials ID.", "type": "string" }, "created": {}, "size": {} } } ], "example": { "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/", "source_key": "", "source_usn": 0, "actions": [ "restoreDisks", "restoreFiles", "downloadFiles", "deleteByAgent", "validate", "replicate" ], "notarized": false, "attributes": { "Kind": "full", "MarkedForDeletion": "0", "SliceMediaIDs": "" }, "resource_ids": [ "EDD63875-4641-44AA-B1A6-BACB4610AA11" ], "change_tag": "b7a6e9b1-f728-45c6-a778-4b97cb651e57", "type": "full" } }, "backup_update_request": { "description": "Backup updating request, modified partial version of the Backup. Identified by `vault_id`, `archive_id` and `backup_id`.", "allOf": [ { "$ref": "#/components/schemas/item0_28" }, { "type": "object", "properties": { "archive_credentials_id": { "description": "Archive credentials ID.", "type": "string" } } } ], "example": { "vault_id": "885b7fe4-95ce-71fd-fff5-8de5b3cce9bb", "archive_id": "1f8867c2-179f-ef34-159f-84279a18174d", "backup_id": "c2aa0462-dd30-4e08-afce-1bad7cfbf8be", "av_scanning_date": "2018-02-02T01:40:05Z", "type": "cdp" }, "type": "object" }, "storage_node_extended": { "description": "Extended info about Storage Node and its vaults.", "example": { "config": { "name": "RU-O0000123", "machine_id": "10.250.176.12" } }, "type": "object", "additionalProperties": false, "required": [ "config" ], "properties": { "config": { "title": "Storage node", "description": "Storage node description.", "type": "object", "additionalProperties": false, "required": [ "name", "machine_id" ], "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "type": "string" }, "machine_id": { "description": "Identifier of the machine with Storage node. Currently hostname or IP address.", "type": "string" }, "status": { "description": "Status of the machine.", "type": "string" }, "addresses": { "description": "Addresses of the machine.", "type": "array", "items": { "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" } ], "type": "string" } }, "tenant_locator": { "type": "string" }, "memory_size": { "description": "Memory size of the machine.", "type": "integer" }, "processor_frequency": { "description": "Processor frequency of the machine.", "type": "integer" }, "processor_name": { "description": "Processor name of the machine.", "type": "string" }, "operating_system_name": { "description": "Operating system name of the machine.", "type": "string" }, "architecture": { "description": "Architecture of the machine.", "type": "string" }, "agent_version": { "description": "Agent version installed in the machine.", "type": "string" }, "vault_count": { "description": "Number of managed vaults.", "type": "integer" } } }, "vaults": { "type": "array", "items": { "description": "Vault info.", "type": "object", "additionalProperties": false, "required": [ "config" ], "properties": { "config": { "$ref": "#/components/schemas/config_29" }, "stats": { "$ref": "#/components/schemas/stats" }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/id" } }, "status": { "type": "object" } } } } } }, "validate_credentials": { "description": "Request to add new vault.", "example": { "session_id": "0F6C5CB2-C01F-4E7C-A061-6F61F01692A1", "uri": "5D0B5B70-BEB7-48A7-94BA-683D86FC3886#storage_credentials" }, "type": "object", "additionalProperties": false, "properties": { "session_id": { "$ref": "#/components/schemas/id" }, "uri": { "description": "URI in Protected storage.", "type": "string" } } }, "find_location": { "description": "Checks if the path provided contains a vault.", "example": { "uri_to_find": "E:\\MyDocuments", "protected_storage": { "session_id": "0F6C5CB2-C01F-4E7C-A061-6F61F01692A1" } }, "type": "object", "additionalProperties": false, "properties": { "uri_to_find": { "description": "Path of possible vault.", "type": "string" }, "protected_storage": { "$ref": "#/components/schemas/protected_storage" } } }, "tenant_id_18": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] }, "item0_19": { "type": "object", "additionalProperties": false, "properties": { "comment": { "type": "string" }, "storage_type": { "$ref": "#/components/schemas/storage_type" }, "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" } } }, "tenant_id_20": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/id" }, { "$ref": "#/components/schemas/item1" } ] }, "access_address": { "description": "Hostname or IP address of Acronis Storage Node to create vault on.", "anyOf": [ { "type": "string", "format": "ipv4" }, { "type": "string", "format": "ipv6" }, { "type": "string", "format": "hostname" }, { "type": "string", "minLength": 0 } ], "type": "string" }, "config": { "title": "Vault description", "description": "Vault description.", "type": "object", "additionalProperties": false, "required": [ "name", "version", "storage_type", "settings" ], "properties": { "id": { "$ref": "#/components/schemas/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/id" }, "storage_type": { "$ref": "#/components/schemas/storage_type" }, "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": [ { "$ref": "#/components/schemas/item0_19" }, { "$ref": "#/components/schemas/item1_21" }, { "$ref": "#/components/schemas/item2" }, { "$ref": "#/components/schemas/item3" }, { "$ref": "#/components/schemas/item4" }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "$ref": "#/components/schemas/access_address" }, "compacting_plan_id": { "$ref": "#/components/schemas/id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "protected_storage": { "type": "object", "additionalProperties": false, "properties": { "session_id": { "$ref": "#/components/schemas/id" } } }, "tapes": { "type": "array", "items": { "$ref": "#/components/schemas/id" } }, "item1_21": { "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": {} } }, "item2": { "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 } } }, "item3": { "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" } } }, "item4": { "title": "Wasabi S3 Vault settings", "description": "Wasabi S3 Vault settings.", "type": "object", "additionalProperties": false, "required": [ "connection_id", "region", "endpoint", "bucket", "path", "s3_subtype" ], "properties": { "connection_id": { "description": "Connection ID is used to get Wasabi credentials from Cloud Connection Service", "type": "string" }, "region": { "description": "Region of the storage", "type": "string" }, "endpoint": { "description": "Endpoint of wasabi based on the region", "type": "string" }, "bucket": { "description": "Bucket name", "type": "string" }, "path": { "description": "Path on the storage.", "type": "string" }, "s3_subtype": { "enum": [ "Wasabi" ], "type": "string" } } }, "tenant_id_22": { "description": "Tenant identifier. Uses numeric identifier in cloud and UUID in on-premises.", "oneOf": [ { "$ref": "#/components/schemas/archive_id_15" }, { "description": "Numeric identifier.", "type": "string", "pattern": "^\\d+$" } ] }, "storage_type_23": { "description": "Vault storage type.", "enum": [ "unknown", "local_folder", "network_share", "ftp", "sftp", "cd", "tape", "storage_server", "asz", "removable_drive", "online", "nfs_share", "esx", "local_abgw", "microsoft_azure", "amazon_s3", "s3_compatible" ], "type": "string" }, "items_24": { "title": "Volume", "description": "Volume description.", "type": "object", "additionalProperties": false, "properties": { "free_space": { "description": "Free volume space in bytes.", "type": "integer" }, "is_bootable": { "type": "boolean" }, "is_system": { "type": "boolean" }, "name": { "type": "string" }, "size": { "description": "Volume size in bytes.", "type": "integer" }, "mount_strid": { "description": "String identifier of the volume.", "type": "string" } } }, "tapes_for_restore_25": { "type": "array", "items": { "$ref": "#/components/schemas/archive_id_15" } }, "checksum_validation_26": { "description": "Value of backup validation status.", "enum": [ "SUCCESS", "FAILURE", "CANCELLED" ], "type": "string" }, "stats": { "title": "Vault stats", "description": "Vault statistics.", "type": "object", "additionalProperties": false, "properties": { "archive_count": { "description": "Number of archives in the vault.", "type": "integer" }, "backup_count": { "description": "Number of backups in the vault.", "type": "integer" }, "backed_up_data_size": { "description": "Size of data stored in vault's backups.", "type": "integer" }, "original_data_size": { "description": "Original size of all data vault holds.", "type": "integer" }, "occupied_data_size": { "description": "Amount of space that vault takes up on storage.", "type": "integer" }, "immutable_size": { "description": "Amount of space that vault takes up on immutable storage.", "type": "integer" }, "free_space": { "description": "Amount of space left on storage where vault is.", "type": "integer" }, "total_space": { "description": "Total about of space on storage where vault is.", "type": "integer" }, "logical_archive_size": { "description": "Logical archive size sum.", "type": "integer" }, "deduplication_stats": { "type": "object", "additionalProperties": false, "properties": { "occupied_deduplication_db_size": { "description": "Amount of space deduplication database takes up.", "type": "integer" }, "free_deduplication_db_size": { "description": "Amount of space left on storage where deduplication database is.", "type": "integer" }, "occupied_deduplication_ds_size": { "description": "Amount of space datastore takes up.", "type": "integer" }, "occupied_deduplication_ram": { "description": "Amount of RAM deduplication database takes up.", "type": "integer" }, "free_deduplication_ram": { "description": "Amount of free RAM that is left for deduplication database to use.", "type": "integer" }, "deduplication_index_usage": { "description": "Load factor of deduplication database.", "type": "string" }, "data_to_index_size": { "description": "Amount of data that needs to be indexed (LDS size).", "type": "integer" } } } } }, "stats_27": { "title": "Archive stats", "description": "Additional information about slices.", "type": "object", "additionalProperties": false, "properties": { "first_backup": { "type": "string" }, "last_backup_size": { "type": "integer" }, "last_backup_path": { "type": "string" }, "backup_count": { "type": "integer" } } }, "orphanage": { "title": "Set archive orphanage status request", "description": "Archive orphanage status description.", "type": "object", "required": [ "status" ], "properties": { "status": { "description": "Value of archive orphanage status.", "enum": [ "NONE", "NO_POLICY", "NO_RESOURCE" ], "type": "string" } } }, "item0_28": { "description": "Backup description.", "type": "object", "additionalProperties": false, "required": [ "vault_id", "archive_id", "backup_id", "type" ], "properties": { "vault_id": { "$ref": "#/components/schemas/id" }, "archive_id": { "$ref": "#/components/schemas/id" }, "backup_id": { "$ref": "#/components/schemas/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_20" }, "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": { "$ref": "#/components/schemas/config_29" }, "archive": { "title": "Archive", "description": "Archive description.", "type": "object", "additionalProperties": false, "required": [ "id", "name", "vault_id", "format", "created", "file_name" ], "properties": { "id": { "$ref": "#/components/schemas/id" }, "name": { "description": "Name of the archive.", "type": "string" }, "vault_id": { "$ref": "#/components/schemas/id" }, "legacy_id": { "description": "ID that is needed for old WCS API support. Don't use it in new services!", "type": "string" }, "attributes": { "description": "Any archive-specific attributes.", "type": "object" }, "size": { "description": "Size of the archive in bytes.", "type": "integer" }, "compressed_data_size": { "description": "Sum of compressed data in all slices in bytes. May be larger than `data_size` in case of dedup. Calculated by archive implementation.", "type": "integer" }, "data_size": { "description": "Size of backed up data in all slices of archive in bytes. Calculated by archive implementation.", "type": "integer" }, "original_data_size": { "description": "Size of the data that can be restored from all slices of the archive in bytes. Calculated by archive implementation.", "type": "integer" }, "type": { "$ref": "#/components/schemas/items_4" }, "format": { "$ref": "#/components/schemas/items_5" }, "created": { "description": "Date and time in RFC 3339 format the archive was created.", "type": "string", "format": "date-time" }, "updated": { "description": "Date and time in RFC 3339 format the archive was updated.", "type": "string", "format": "date-time" }, "last_backup_created": { "description": "Date and time in RFC 3339 format the last slice was created.", "type": "string", "format": "date-time" }, "resource_type": { "description": "Type of resource stored in archive (e.g., `machine`, `mssql_server`). Can include additional resource type (e.g., type of VM: `datastore.vmwesx`, `virtual_appliance.mshyperv`).", "type": "string" }, "protected_by_password": { "description": "If true, the archive is protected by password. False otherwise.", "type": "boolean" }, "encryption_algorithm": { "description": "Encryption algorithm of the archive.", "enum": [ "none", "aes_128", "aes128", "aes_192", "aes192", "aes_256", "aes256", "gost" ], "type": "string" }, "deleted": { "description": "If true, the archive is deleted and no longer exists. False otherwise.", "type": "boolean" }, "file_name": { "description": "The archive file name.", "type": "string" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Locator of the tenant that owns the archive.", "type": "string" }, "agent_id": { "$ref": "#/components/schemas/id" }, "source_key": { "description": "Key of archive in DML DB. Used for legacy agents support.", "type": "string" }, "source_usn": { "description": "Timestamp of archive in DML DB. Used for legacy agents support.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "agent_name": { "description": "Hostname of agent machine.", "type": "string", "format": "hostname" }, "centralized_plan_id": { "description": "Global identifier of the backup plan in accordance to that the archive is created.", "type": "string" }, "backup_plan_id": { "description": "ID of the backup plan that created the archive.", "type": "string" }, "backup_plan_name": { "description": "Name of the backup plan that created the archive.", "type": "string" }, "description": { "description": "User-defined description.", "type": "string" }, "display_name": { "description": "Human-readable archive name.", "type": "string" }, "owner_id": { "description": "ID of the user (SID for Windows) that owns the archive.", "type": "string" }, "owner_name": { "description": "Name of the user that owns the archive.", "type": "string" }, "resource_id": { "description": "ID of the resource that stored in the archive.", "type": "string" }, "resource_ids": { "description": "List of identifiers of backed up resources.", "type": "array", "items": { "description": "ID of backed up resource.", "type": "string" } }, "resource_name": { "description": "Name of the resource that stored in the archive.", "type": "string" }, "consistent": { "description": "False if archive content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "stats": { "$ref": "#/components/schemas/stats_27" }, "marked_for_deletion": { "description": "True if archive marked as deleted. False otherwise.", "type": "boolean" }, "pds_status": { "description": "State of physical data shipment.", "enum": [ "archiveNotReady", "archiveInTransit", "archiveDelivered" ], "type": "string" }, "search_index_size": { "description": "Size of search index.", "type": "integer" }, "resource_path": { "description": "Path to the backed up resource in a format acceptable by Resource Manager.", "type": "string" }, "last_seen_at": { "description": "Last time when the archive was seen.", "type": "string", "format": "date-time" }, "cataloged_status": { "description": "State of archive is cataloged.", "enum": [ "notIndexed", "partiallyIndexed", "indexed" ], "type": "string" }, "forensic": { "description": "True if the archive contains forensic data. False otherwise.", "type": "boolean" }, "pre_patch_management": { "description": "Flag that specifies whether the archive contains at least one backup which was made before patch management. True if there's at least one backup that was made before patch management. False otherwise.", "type": "boolean" }, "malware_found": { "description": "Malware assessment result of backups in the archive. Absent if no backups were scanned. True if at least one backup has malware. False otherwise.", "type": "boolean" }, "logical_size": { "description": "Reflects logical size of archive.", "type": "integer" }, "immutable_size": { "description": "Reflects immutable size of archive.", "type": "integer" }, "deleted_immutable": { "description": "True if the archive is marked as deleted immutable. False otherwise.", "type": "boolean" }, "orphanage": { "$ref": "#/components/schemas/orphanage" } } }, "disks": { "description": "Disks in the Disk-image backup.", "type": "array", "items": { "title": "Disk", "description": "Disk description.", "type": "object", "additionalProperties": false, "properties": { "device_model": { "type": "string" }, "name": { "type": "string" }, "size": { "description": "Disk size in bytes.", "type": "integer" }, "volumes": { "type": "array", "items": { "$ref": "#/components/schemas/items_30" } } } } }, "dynamic_volumes": { "description": "Dynamic volumes in the Disk-image backup.", "type": "array", "items": { "$ref": "#/components/schemas/items_30" } }, "source_key": { "description": "Old agents sync info.", "type": "string" }, "source_usn": { "description": "Old agents sync info.", "type": "integer" }, "actions": { "description": "List of available actions.", "type": "array", "items": { "type": "string" } }, "last_seen_at": { "description": "Date and time in RFC 3339 format the backup was last seen.", "type": "string", "format": "date-time" }, "change_tag": { "description": "User-defined identifier to mark records affected by this request (obsolete).", "type": "string" }, "failover_check_info": { "title": "Failover check info", "description": "Information about status of failover.", "type": "object", "additionalProperties": false, "properties": { "error": { "description": "Failover check error.", "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "domain": { "type": "string" } } }, "is_critical_error": { "description": "True if check has failed with error that is critical for failover. False otherwise.", "type": "boolean" } } }, "triggered_by": { "$ref": "#/components/schemas/items_1" }, "av_scanning_date": { "description": "Date and time in RFC 3339 format when backup was scanned by antivirus. Input timezone is removed by conversion to UTC", "type": "string", "format": "date-time" }, "vulnerability_assessment_result": { "description": "Vulnerability assessment result:\n* 0 - clean.\n* 1 - malicious.\n 2 - unknown.\n 3 - failed.\n* 4 - unsupported.", "enum": [ 0, 1, 2, 3, 4 ], "type": "integer" }, "malware_assessment_result": { "description": "Malware assessment result:\n* 0 - clean.\n* 1 - malware.\n* 4 - unsupported (unsupported file system).", "enum": [ 0, 1, 4 ], "type": "integer" }, "type": { "$ref": "#/components/schemas/items" }, "tapes": { "$ref": "#/components/schemas/tapes" }, "tapes_for_restore": { "$ref": "#/components/schemas/tapes" }, "deleted_immutable": { "description": "True if the backup is marked as deleted immutable. False otherwise.", "type": "boolean" }, "validation_status": { "description": "Result of backup validation.", "type": "object", "additionalProperties": false, "required": [ "overall_status" ], "properties": { "overall_status": { "$ref": "#/components/schemas/checksum_validation_31" }, "checksum_validation": { "$ref": "#/components/schemas/checksum_validation_31" }, "vm_heartbeat_validation": { "$ref": "#/components/schemas/checksum_validation_31" }, "screenshot_validation": { "$ref": "#/components/schemas/checksum_validation_31" }, "screenshot_full_url": { "description": "URL to screenshot file (this is an optional unsigned URL to S3 storage).", "type": "string" }, "screenshot_preview_url": { "description": "URL to screenshot preview file (this is an optional unsigned URL to S3 storage).", "type": "string" } } }, "automated_test_failover_validation_status": { "description": "Status of backup validation by Disaster Recovery Automated Test Failover feature.", "type": "object", "additionalProperties": false, "required": [ "completed_at", "overall_status", "started_at", "task_id" ], "properties": { "completed_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was completed. Input timezone is removed by conversion to UTC.", "type": "string", "format": "date-time" }, "overall_status": { "$ref": "#/components/schemas/checksum_validation_31" }, "started_at": { "description": "Date and time in RFC 3339 format when Automated Test Failover validation of the Backup was started. Input timezone is removed by conversion to UTC.", "type": "string" }, "screenshot_full_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "screenshot_preview_url": { "description": "URL to Vault Manager which redirects to signed S3 storage URL with screenshot preview file produced during backup validation by Disaster Recovery Automated Test Failover feature (optional).", "type": "string" }, "task_id": { "description": "The ID of the Task Manager task which the Automated Test Failover process was started from.", "type": "string" } } }, "created_in_network_isolation": { "description": "True if the backup was created after network isolation. False otherwise.", "type": "boolean" } } }, "config_29": { "title": "Vault description", "description": "Vault description.", "type": "object", "additionalProperties": false, "required": [ "name", "version", "storage_type", "settings" ], "properties": { "id": { "$ref": "#/components/schemas/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/id" }, "storage_type": { "$ref": "#/components/schemas/storage_type" }, "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": [ { "$ref": "#/components/schemas/item0_19" }, { "$ref": "#/components/schemas/item1_21" }, { "$ref": "#/components/schemas/item2" }, { "$ref": "#/components/schemas/item3" }, { "$ref": "#/components/schemas/item4" }, { "type": "object" } ] }, "storage_id": { "description": "ID of the storage, for Local ABGW Vault or Storage node Vault.", "type": "string" }, "status": { "description": "Status of the vault.", "type": "object" }, "tenant_id": { "$ref": "#/components/schemas/tenant_id_20" }, "tenant_locator": { "description": "Tenant locator.", "type": "string" }, "access_address": { "$ref": "#/components/schemas/access_address" }, "compacting_plan_id": { "$ref": "#/components/schemas/id" }, "hostname": { "description": "Hostname of local vault.", "type": "string", "format": "hostname" }, "consistent": { "description": "False if vault content could be outdated and a refresh is required. True otherwise.", "type": "boolean" }, "last_seen_at": { "description": "Date and time in RFC 3339 format when the vault was last seen.", "type": "string", "format": "date-time" }, "is_full_config": { "description": "True if `name`, `uri`, `settings`, `storage_type` are filled. False otherwise.", "type": "boolean" } } }, "items_30": { "title": "Volume", "description": "Volume description.", "type": "object", "additionalProperties": false, "properties": { "free_space": { "description": "Free volume space in bytes.", "type": "integer" }, "is_bootable": { "type": "boolean" }, "is_system": { "type": "boolean" }, "name": { "type": "string" }, "size": { "description": "Volume size in bytes.", "type": "integer" }, "mount_strid": { "description": "String identifier of the volume.", "type": "string" } } }, "checksum_validation_31": { "description": "Value of backup validation status.", "enum": [ "SUCCESS", "FAILURE", "CANCELLED" ], "type": "string" } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "password": { "scopes": { "vault_manager::system_admin": "", "vault_manager::admin": "", "vault_manager::core_restore": "", "vault_manager::c2c_restore": "", "vault_manager::orphanage_readwrite": "", "vault_manager::read": "", "protection::readonly": "", "root_admin": "", "partner_admin": "", "infra_admin": "" }, "tokenUrl": "https://dev-cloud.acronis.com/api/2/idp/token" }, "authorizationCode": { "scopes": { "vault_manager::system_admin": "", "vault_manager::admin": "", "vault_manager::core_restore": "", "vault_manager::c2c_restore": "", "vault_manager::orphanage_readwrite": "", "vault_manager::read": "", "protection::readonly": "", "root_admin": "", "partner_admin": "", "infra_admin": "" }, "authorizationUrl": "https://dev-cloud.acronis.com/api/2/idp/authorize", "tokenUrl": "https://dev-cloud.acronis.com/api/2/idp/token" } } } } }, "servers": [ { "url": "https://dev-cloud.acronis.com/api/vault_manager/v1", "variables": {} } ] }