Enable backup of multiple volumes
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume
Enables the backup of multiple volumes. Backup is not allowed for a volume enabled with a NetApp SnapLock license (WORM license). You can configure the different optional backup modes. The AD_HOC mode creates an on-demand Snapshot copy and stores a backup on the respective cloud object storage. SCHEDULED mode (default mode) creates a Snapshot copy 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 specific 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": [
{
"file-system-id": "string",
"mode": "string",
"backup-policy-name": "string"
}
]
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Example response
{
"job-id": "string"
}Definitions
See Definitions
volume
| Name | Type | Required | Description |
|---|---|---|---|
file-system-id |
string |
True |
|
mode |
string |
False |
|
backup-policy-name |
string |
False |
body
| Name | Type | Required | Description |
|---|---|---|---|
volume |
array[volume] |
True |