Perform a volume and file-level restore (v2)
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/restore
Performs a volume and file level restore (V2 version) operation. This API validates whether a backup of a volume exists. The restore operation is not supported on data protection volumes, on a target volume with a different language code than the source volume, and for volumes with size less than 1GB. The restore operation is not allowed on a volume enabled with a SnapLock license (WORM license). It checks whether the source and target cloud provider matches. It also verifies whether the backup and restore operation is supported in the system.
If DataLock and ransomware protection is enabled on a system, ransomware scan is performed on the specified cloud backup that relates to a particular volume when it is chosen to be restored. To skip the scan, set the "skip-ransomware-check" parameter to "true".
Token usage: NetApp Console user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
accountId |
string |
path |
True |
Account ID |
authorization |
string |
header |
True |
User token |
X-Agent-Id |
string |
header |
True |
Request identifier |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
restore |
True |
Example request
{
"restore": {
"type": "string",
"restore-source": "string",
"archive-restore-priority": "string",
"source": {
"working-environment-id": "string",
"working-environment-name": "string",
"bucket": "string",
"volume-name": "string",
"volume-id": "string",
"snapshot": "string"
},
"target": {
"working-environment-id": "string",
"working-environment-name": "string",
"svm": "string",
"aggregate": "string",
"volume-name": "string",
"path": "string"
},
"file": [
{}
]
}
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Example response
{
"job-id": "string"
}Definitions
See Definitions
source
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-id |
string |
True |
|
working-environment-name |
string |
True |
|
bucket |
string |
True |
|
volume-name |
string |
True |
|
volume-id |
string |
True |
|
snapshot |
string |
True |
target
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-id |
string |
True |
|
working-environment-name |
string |
True |
|
svm |
string |
True |
|
aggregate |
string |
False |
|
volume-name |
string |
True |
|
path |
string |
False |
|
retain-source-path |
boolean |
False |
file
| Name | Type | Required | Description |
|---|---|---|---|
inode |
number |
True |
|
path |
string |
True |
|
type |
string |
True |
|
size |
number |
True |
|
mtime |
number |
True |
restore
| Name | Type | Required | Description |
|---|---|---|---|
type |
string |
True |
|
restore-source |
string |
False |
Specifies the source of the restore |
archive-restore-priority |
string |
False |
Required to specify the archival retrieval priority to determine the restoration time |
source |
True |
||
target |
True |
||
file |
array[file] |
False |
|
skip-ransomware-check |
boolean |
False |
Skips a ransomware scan |
skip-file-rename |
boolean |
False |
Skips file rename while restore |
is-on-demand-restore |
boolean |
False |
Triggers an on-demand restore |
skip-azure-private-endpoint-creation |
boolean |
False |
Optional input field to skip private endpoint creation for Azure |
body
| Name | Type | Required | Description |
|---|---|---|---|
restore |
True |