The API allows you to list, view and remove mounted backups.
Returns a list of mounted backups filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
backup | query | ||
direction | query | ||
filter | query | ||
finished-mount | query | boolean | |
mode | query | "AUTO" or "CLOUD_DOWNLOAD" or "CLOUD_PST_DOWNLOAD" or "INSTANT_RESTORE" or "ISCSI" or "MANUAL" or "OS_DOWNLOAD" | |
nameLike | query | ||
node | query | ||
orderBy | query | ||
page | query | ||
project-uuid | query | ||
protected-entity | query | ||
protected-entity-type | query | "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM" | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of MountedBackupListRecord (JSON) | list of mounted backups filtered by specified query parameters |
GET /mounted-backups
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"backup" : {
"archiveExpire" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"statusInfo" : "...",
"protectedEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"parentBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
"warningsPresent" : true,
"warnings" : [ "...", "..." ],
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"description" : "...",
"backupLocations" : [ {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupDestinationType" : "SYNTHETICDDBOOST",
"status" : "IN_PROGRESS",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "ARCHIVE"
}, {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupDestinationType" : "NETWORKER",
"status" : "IN_PROGRESS",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "TO_REMOVE"
} ],
"originEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hidden" : true,
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"taskDurationTime" : 12345,
"sourceNameAndGuid" : {
"guid" : "...",
"name" : "...",
"type" : "APPLICATION"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"backupTime" : 1451677502000,
"snapshotTime" : 1451649601000,
"status" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
},
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"mountedFileCount" : 12345,
"mountedFileSystemCount" : 12345,
"mountedDisks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"allowedClients" : [ "...", "..." ],
"sharedMountPath" : "...",
"creationTime" : 12345,
"cloudFeature" : "TEAMS_MEMBERS",
"downloadStatus" : "SUCCESS",
"hvManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvmType" : "HYPERV",
"state" : "SUCCESS",
"hvType" : "CITRIX",
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"targetHypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"restoredVmUuid" : "...",
"lastMountTaskId" : "...",
"lastRestoreTaskId" : "...",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"mode" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Get a single mounted backup.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for mounted backup (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | MountedBackupDetails (JSON) | mounted backup details |
GET /mounted-backups/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"backup" : {
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"parentBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupLocations" : [ {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupDestinationType" : "GCS",
"status" : "REMOVED",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "ARCHIVE"
}, {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupDestinationType" : "AZURE",
"status" : "PRESENT",
"type" : "SYNCHRONIZATION",
"statusInfo" : "...",
"retentionHint" : "RECREATE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : { },
"virtualMachine" : { },
"backups" : [ { }, { } ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : { },
"virtualMachine" : { },
"backups" : [ { }, { } ]
} ],
"size" : 12345,
"fileCount" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "VM_IMAGE_PLUS_INCREMENTAL_DISKS",
"warningsPresent" : true,
"warnings" : [ "...", "..." ],
"baseImage" : {
"uuid" : "..."
},
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hidden" : true,
"retentionHint" : "ARCHIVE",
"originEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"snapshotTime" : 1451649601000,
"status" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
},
"mountedFileCount" : 12345,
"mountedFileSystemCount" : 12345,
"allowedClients" : [ "...", "..." ],
"mountedDisks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sharedMountPath" : "...",
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"creationTime" : 12345,
"restoredVmUuid" : "...",
"nfsStorageId" : "...",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"mode" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change mounted backup details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for mounted backup (used by vProtect) |
media type | data type | description |
---|---|---|
application/json | MountedBackupUpdateRequest (JSON) | specify mounted backup details to update |
media type | data type | description |
---|---|---|
application/json | MountedBackupDetails (JSON) | updated details of mounted backup |
PUT /mounted-backups/{guid}
Content-Type: application/json
Accept: application/json
{
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"finishedMount" : true,
"sharedMountPath" : "..."
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"backup" : {
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"parentBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupLocations" : [ {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "SECONDARY",
"backupDestinationType" : "AVAMAR",
"status" : "IN_PROGRESS",
"type" : "SYNCHRONIZATION",
"statusInfo" : "...",
"retentionHint" : "DONT_TOUCH"
}, {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupDestinationType" : "RUBRIK",
"status" : "PRESENT",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "RECREATE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : { },
"virtualMachine" : { },
"backups" : [ { }, { } ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : { },
"virtualMachine" : { },
"backups" : [ { }, { } ]
} ],
"size" : 12345,
"fileCount" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
"warningsPresent" : true,
"warnings" : [ "...", "..." ],
"baseImage" : {
"uuid" : "..."
},
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hidden" : true,
"retentionHint" : "DONT_TOUCH",
"originEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"snapshotTime" : 1451649601000,
"status" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
},
"mountedFileCount" : 12345,
"mountedFileSystemCount" : 12345,
"allowedClients" : [ "...", "..." ],
"mountedDisks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sharedMountPath" : "...",
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"creationTime" : 12345,
"restoredVmUuid" : "...",
"nfsStorageId" : "...",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"mode" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Update mounted backup restored vm uuid.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for mounted backup (used by vProtect) |
media type | data type | description |
---|---|---|
application/json | string (JSON) | uuid restored Vm |
media type | data type | description |
---|---|---|
application/json | MountedBackupDetails (JSON) | updated details of mounted backup |
PUT /mounted-backups/{guid}/mounted-restored-vmid
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"backup" : {
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"parentBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupLocations" : [ {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupDestinationType" : "AZURE",
"status" : "REMOVED",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "STANDARD_RETENTION"
}, {
"guid" : "...",
"backup" : { },
"snapshotTime" : 12345,
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupDestinationType" : "ISP",
"status" : "PRESENT",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "ARCHIVE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : { },
"virtualMachine" : { },
"backups" : [ { }, { } ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : { },
"virtualMachine" : { },
"backups" : [ { }, { } ]
} ],
"size" : 12345,
"fileCount" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
"warningsPresent" : true,
"warnings" : [ "...", "..." ],
"baseImage" : {
"uuid" : "..."
},
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hidden" : true,
"retentionHint" : "ARCHIVE",
"originEntity" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"snapshotTime" : 1451649601000,
"status" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
},
"mountedFileCount" : 12345,
"mountedFileSystemCount" : 12345,
"allowedClients" : [ "...", "..." ],
"mountedDisks" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sharedMountPath" : "...",
"node" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"creationTime" : 12345,
"restoredVmUuid" : "...",
"nfsStorageId" : "...",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"mode" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}