Skip to main content

Enable backup for a volume (v3)

Contributors

POST /account/{accountId}/providers/cloudmanager_cbs/api/v3/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}

Enables backup for a specified volume (version 3). This version of the endpoint runs the job asynchronously. 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 specific cloud object storage system. Using this endpoint, you can set the archive after days parameter to move the volume data to the archive tier and also enable object lock and ransomware detection features on the volume.

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 ONTAP snapshot policy and backs it up to the cloud as per the backup policy. [Deprecated] IMMEDIATE mode designed for internal use case and not to be used for newer integrations

  • enum: ["AD_HOC", "SCHEDULED", "IMMEDIATE"]

backup-policy

backup-policy

False

Example request
{
  "mode": "string",
  "backup-policy": {
    "name": "string",
    "rule": [
      {
        "label": "string",
        "retention": "string"
      }
    ],
    "archive-after-days": "string",
    "object-lock": "string"
  }
}

Response

Status: 202, Default response
Name Type Required Description

job-id

string

False

Example response
{
  "job-id": "string"
}

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

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 ONTAP snapshot policy and backs it up to the cloud as per the backup policy. [Deprecated] IMMEDIATE mode designed for internal use case and not to be used for newer integrations

  • enum: ["AD_HOC", "SCHEDULED", "IMMEDIATE"]

backup-policy

backup-policy

False