SAP HANA Application-Free Restores
Use this API to restore data obtained through a backup
- application/json
Request Body
taskInfo object
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
Task ID
- jobIds string[]
Restore Job ID
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 293241,
"jobIds": [
"356605"
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
POST /createtask
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'
curl -L -X POST 'https://localhost/webconsole/api/CREATETASK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"associations": [
{
"instanceName": "string",
"appName": "SAP HANA",
"consumeLicense": true,
"applicationId": 135,
"clientName": "string",
"clientSidePackage": true,
"subclientName": "string",
"backupsetName": "default"
}
],
"task": {
"taskType": 0,
"initiatedFrom": 0,
"policyType": 0,
"taskFlags": {
"disabled": false
}
},
"subTasks": [
{
"subTaskOperation": 0,
"subTask": {
"subTaskType": 0,
"operationType": 1005
},
"options": {
"adminOpts": {
"contentIndexingOption": {
"subClientBasedAnalytics": false
}
},
"restoreOptions": {
"impersonation": {
"useImpersonation": false,
"user": {}
},
"virtualServerRstOption": {
"isBlockLevelReplication": false,
"isDiskBrowse": false
},
"volumeRstOption": {
"volumeLeveRestore": false
},
"browseOption": {
"noImage": false,
"listMedia": false,
"useExactIndex": false,
"mediaOption": {
"mediaAgent": {
"_type_": 0
},
"library": {
"_type_": 0
},
"copyPrecedence": {
"copyPrecedence": 0,
"copyPrecedenceApplicable": true
},
"drivePool": {
"_type_": 0
}
},
"backupset": {
"clientName": "string",
"instanceName": "string",
"backupsetName": "default"
}
},
"commonOptions": {
"systemStateBackup": false,
"restoreToDisk": true,
"offlineMiningRestore": false,
"indexFreeRestore": true,
"restoreToExchange": false,
"restoreOnlyStubExists": false,
"restoreACLs": false,
"overwriteFiles": true,
"doNotOverwriteFileOnDisk": false,
"dataInDeviceNode": false,
"unconditionalOverwrite": false,
"syncRestore": false
},
"destination": {
"isLegalHold": false,
"restoreOnlyIfTargetExists": false,
"noOfStreams": 0,
"inPlace": false,
"destClient": {
"clientName": "string"
},
"destPath": "string"
},
"fileOption": {
"sourceItem": "2:Backup job ID"
},
"distributedAppsRestoreOptions": {
"distributedRestore": false,
"isMultiNodeRestore": false
},
"sharePointRstOption": {
"is90OrUpgradedClient": false
}
}
}
}
]
}
}'