Restore Subclient
Select
Perform the restore of a file server subclient.
- application/json
Request Body
taskInfo object
associations object[]
Subclient association
clientId integerClient ID. Provide Client Id or Name
clientName stringClient Name
displayName stringDiplay Name
subclientId integerId of the subclient to restore
subclientGUID stringsubclient GUID
subclientName stringSubclient Name. Provide name of Id
applicationId integerApplication ID 29 for File System Unix, 33 for Windows
appName stringFile System
backupsetId integerBackupset Id of the subclient
backupsetName stringBackupset name of the subclient
instanceId integerInstance ID of the backupset
instanceName stringInstance name of the backupset
csGUID stringCommServe Guid
commCellName string_type_ integerentityInfo object
Company Info if subclient belongs to company client
companyId integercompanyName stringtask object
taskType stringDefault value:
IMMEDIATE
IMMEDIATE
initiatedFrom stringDefault value:
GUI
GUI
subTasks object[]
subTask object required
subTaskType stringDefault value:
RESTORE
RESTORE
operationType stringDefault value:
RESTORE
RESTORE
options object
restoreOptions object
restoreACLsType string requiredPossible values: [
ACL_DATA
,DATA_ONLY
,ACL_ONLY
]Select the Restore type
impersonation object
useImpersonation booleanDefault value:
false
user object
userName stringusername of impersonated user
password stringpassword of user impersonation
virtualServerRstOption object
isVolumeBrowse booleanDefault value:
false
volumeRstOption object
volumeLeveRestore booleanDefault value:
false
browseOption object
browseJobCommCellId integerDefault value:
2
Commcell ID
noImage booleanDefault value:
false
commCellId integerDefault value:
2
backupset object required
BackupSet Entity info
backupsetId integer requiredBackupSet ID of subclient
backupsetName stringBackupset name of the subclient
clientId integerClient ID of the subclient
clientName stringClient name of the subclient
commonOptions object
isFromBrowseBackup booleanDefault value:
true
preserveLevel integerDefault value:
1
Preserve the folder level
stripLevelType integeroverwriteFiles booleanDefault value:
true
unconditionalOverwrite booleanUnconditionally overwrite if it already exists
destination object required
destAppId integer29 for unix 33 for windows
inPlace boolean requiredSet to true for restore to original folder
destClient object
Destination info
clientId integerClient ID
clientName stringClient Name of the destination
destinationInstance object
destPath string[]Destination path for out of place restore
applicationId integerPossible values: [
29
,33
]Application ID . 33 for windows file system 29 for Unix file system
clientName stringDestination Client Name
clientId integerDestination Client ID
noOfStreams integerNumber of streams to use
fileOption object required
sourceItem string[] requiredList of contents to restore
fsCloneOptions object
cloneMountPath stringqrOption object
destAppTypeId integerPossible values: [
29
,33
]Destination clinet app Id 33 for Windows, 29 for Unix
commonOpts object
notifyUserOnJobCompletion booleanSend email on completion
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
Restore Job Id
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 1124,
"jobIds": [
"124114"
]
}