Get started
Enable backup for multiple volumes (v2)
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v2/backup/working-environment/{workingEnvironmentId}/volume
Enables backup for multiple volumes (version 2). Backup is not allowed for a volume enabled with a SnapLock license (WORM license). You can configure the different backup modes. The AD_HOC mode creates an on-demand Snapshot copy and stores a backup on the respective cloud. SCHEDULED mode (default mode) creates Snapshot copies as per the ONTAP Snapshot policy and stores a backup on the cloud as per the backup policy. Based on the defined backup policy, this API endpoint creates a SnapMirror to cloud relationship with a cloud object storage system.
Token usage: BlueXP user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
accountId |
string |
path |
True |
Account ID |
workingEnvironmentId |
string |
path |
True |
Working environment ID |
authorization |
string |
header |
True |
User token |
x-agent-id |
string |
header |
True |
Request identifier |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
volume |
array[volume] |
True |
Example request
{
"volume": {
}
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Definitions
See Definitions
rule
| Name | Type | Required | Description |
|---|---|---|---|
label |
string |
False |
|
retention |
string |
False |
backup-policy
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
Required input |
rule |
array[rule] |
False |
|
archive-after-days |
string |
False |
|
object-lock |
string |
False |
volume
| Name | Type | Required | Description |
|---|---|---|---|
volume-id |
string |
True |
|
mode |
string |
False |
|
backup-policy |
False |
body
| Name | Type | Required | Description |
|---|---|---|---|
volume |
array[volume] |
True |