Get started
Enable backup for a volume
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}
Enables backup for a specified volume. Backup is not allowed for a volume enabled with a SnapLock license (WORM license). You can configure optional backup modes. The AD_HOC mode creates an ad-hoc Snapshot copy and creates a backup on the respective cloud. SCHEDULED mode (default mode) creates a Snapshot copy as per the ONTAP Snapshot policy and creates a backup on the cloud as per the backup policy.Based on the defined backup policy, the API endpoint creates a SnapMirror to cloud relationship with a specific cloud object storage.
Token usage: BlueXP user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
accountId |
string |
path |
True |
Account ID |
workingEnvironmentId |
string |
path |
True |
Working environment ID |
volumeId |
string |
path |
True |
Volume ID |
authorization |
string |
header |
True |
User token |
x-agent-id |
string |
header |
True |
Request identifier |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
mode |
string |
False |
AD_HOC mode creates an on-demand Snapshot copy and backs it up on the respective cloud. SCHEDULED mode creates Snapshot copies as per the ONTAP Snapshot policy and backs it up on the cloud as per the backup policy.
|
backup-policy-name |
string |
False |
Example request
{
"mode": "AD_HOC"
}Response
Status: 200, Default response| Name | Type | Required | Description |
|---|---|---|---|
state |
string |
False |
Definitions
See Definitions
body
| Name | Type | Required | Description |
|---|---|---|---|
mode |
string |
False |
AD_HOC mode creates an on-demand Snapshot copy and backs it up on the respective cloud. SCHEDULED mode creates Snapshot copies as per the ONTAP Snapshot policy and backs it up on the cloud as per the backup policy.
|
backup-policy-name |
string |
False |