Skip to main content

SAP HANA Application-Free Restores

Use this API to restore data obtained through a backup

Request Body
  • taskInfo object
  • associations object[]
  • instanceName string required

    Provide SAP HANA InstanceName

  • appName string

    Default value: SAP HANA

  • consumeLicense boolean

    Default value: true

  • applicationId integer required

    Default value: 135

  • clientName string required

    SAP HANA Pseudo client name

  • clientSidePackage boolean

    Default value: true

  • subclientName string required

    Subclient name

  • backupsetName string required

    Default value: default

  • task object
  • taskType integer
  • initiatedFrom integer
  • policyType integer
  • taskFlags object
  • disabled boolean

    Default value: false

  • subTasks object[]
  • subTaskOperation integer
  • subTask object
  • subTaskType integer
  • operationType integer
  • options object
  • adminOpts object
  • contentIndexingOption object
  • subClientBasedAnalytics boolean

    Default value: false

  • restoreOptions object
  • impersonation object
  • useImpersonation boolean

    Default value: false

  • user object
  • virtualServerRstOption object
  • isBlockLevelReplication boolean

    Default value: false

  • isDiskBrowse boolean

    Default value: false

  • volumeRstOption object
  • volumeLeveRestore boolean

    Default value: false

  • browseOption object
  • noImage boolean

    Default value: false

  • listMedia boolean

    Default value: false

  • useExactIndex boolean

    Default value: false

  • mediaOption object
  • mediaAgent object
  • _type_ integer
  • library object
  • _type_ integer
  • copyPrecedence object
  • copyPrecedence integer required

    provide copy precedence no

  • copyPrecedenceApplicable boolean

    Default value: true

  • drivePool object
  • _type_ integer
  • backupset object
  • clientName string required

    SAP HANA Pseudo client name

  • instanceName string required

    SAP HANA Instance Name

  • backupsetName string required

    Default value: default

    backupset name

  • commonOptions object
  • systemStateBackup boolean

    Default value: false

  • restoreToDisk boolean required

    Default value: true

  • offlineMiningRestore boolean

    Default value: false

  • indexFreeRestore boolean

    Default value: true

  • restoreToExchange boolean

    Default value: false

  • restoreOnlyStubExists boolean

    Default value: false

  • restoreACLs boolean

    Default value: false

  • overwriteFiles boolean

    Default value: true

  • doNotOverwriteFileOnDisk boolean

    Default value: false

  • dataInDeviceNode boolean

    Default value: false

  • unconditionalOverwrite boolean

    Default value: false

  • syncRestore boolean

    Default value: false

  • destination object
  • isLegalHold boolean

    Default value: false

  • restoreOnlyIfTargetExists boolean

    Default value: false

  • noOfStreams integer
  • inPlace boolean

    Default value: false

  • destClient object
  • clientName string required

    SAP HANA Physical client Hostname

  • destPath string required

    Destination Full path where you want to restore data

  • fileOption object
  • sourceItem string required

    Default value: 2

    2:

  • distributedAppsRestoreOptions object
  • distributedRestore boolean

    Default value: false

  • isMultiNodeRestore boolean

    Default value: false

  • sharePointRstOption object
  • is90OrUpgradedClient boolean

    Default value: false

Responses

OK


Schema
  • taskId integer

    Task ID

  • jobIds string[]

    Restore Job ID

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
Security Scheme
token
Body

{
"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
}
}
}
}
]
}
}'