Skip to main content

Perform a volume, file, and folder-level restore operation (V3)

Contributors

POST /account/{accountId}/providers/cloudmanager_cbs/api/v3/restore

Performs a volume, file, and folder-level restore (version 3) operation. It is also possible to do a multi-level or nested-level folder restore. This API validates whether a backup of a volume exists. The restore operation is not supported on data protection volumes, target volume with a different language code than the source volume, volumes with a size less than 1 GB, and volumes enabled with a SnapLock license (WORM license). In addition, restoring both files and folders are not supported. Restoring multiple folders are also not supported. It checks whether the source and target cloud providers match and it also verifies whether the backup and restore operation is supported in the working environments.

If DataLock and ransomware protection is enabled on a working environment, a ransomware scan is performed on a specified cloud backup pertaining to a particular volume when it is chosen to be restored. To skip the scan, set the "skip-ransomware-check" parameter to "true".

This version adds support for accepting a list of target aggregates.

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

restore

True
Example request 
{
  "restore": {
    "type": "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",
      "volume-name": "string",
      "path": "string",
      "aggregates": [
        "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

volume-name

string

True

path

string

False

retain-source-path

boolean

False

aggregates

array[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

archive-restore-priority

string

False

Required to specify the archival retrieval priority to determine the restoration time

source

source

True

target

target

True

file

array[file]

False

skip-ransomware-check

boolean

False

Skips a ransomware scan

skip-file-rename

boolean

False

Skip file rename while restore

body

Name Type Required Description

restore

restore

True