Skip to main content

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

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 operation. This API validates whether a backup of a volume exists. The restore operation is not supported on data protection volumes, a target volume with a different language code than the source volume, volumes with a size of less than 1GB, and volumes enabled with a SnapLock license (WORM license). In addition, restoring both files and folders is not supported. Restoring multiple folders is also not supported. The API checks whether the source and target cloud providers match and also verifies whether the backup and restore operation is supported in the system.

If DataLock and ransomware protection is enabled on a system, a ransomware scan is performed on the specified cloud backup related to the volume that is to be restored. To skip the scan, set the "skip-ransomware-check" parameter to "true".

To indicate that the volume restore is part of an application restore workflow, set the "is-app-volume-restore" parameter to "true". This disables certain steps such as mounting the volume after the storage volume restore.

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

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

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",
      "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

string

True

path

string

True

type

string

True

size

number

True

mtime

number

True

source-file-path

string

False

restore

Name Type Required Description

type

string

True

restore-source

string

False

Specifies the source of the restore

restore-to-replication-source

boolean

False

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

Skips file rename during the restore

is-on-demand-restore

boolean

False

Triggers an on-demand restore

is-app-volume-restore

boolean

False

Indicates that the volume restore is part of an application restore workflow

skip-azure-private-endpoint-creation

boolean

False

Optional input field to skip private endpoint creation for Azure

body

Name Type Required Description

restore

restore

True