Get started
Perform a volume and file-level restore
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/restore
Performs a volume and file-level restore operation. This API endpoint validates whether a backup of a volume exists. 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. 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 on the specified working environments.
Token usage: BlueXP 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 |
Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
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 |
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 |
|
source |
True |
||
target |
True |
||
file |
array[file] |
False |
body
| Name | Type | Required | Description |
|---|---|---|---|
restore |
True |