Skip to main content

Create a backup policy

Contributors

POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy

Creates a backup policy in a working environment. The number of retained backups can be up to a maximum of 1018 when no backup policies are assigned to the volume. You can edit a policy to create up to 4000 backups after you assign volumes to a policy through ONTAP CLI. This API endpoint validates whether the ONTAP version used by a working environment supports archiving. You can archive the backups to a cloud archive tier by setting the archive-after-days in the policy. You can archive to AWS Glacier, Deep Glacier, Azure Archive, and Google Archive.

You can enable DataLock and Ransomware protection beginning with ONTAP 9.11.1 and later (supported for AWS, Azure, and StorageGRID). This is applicable only for new backup activation. Interoperability with archival policy is not supported. For AWS, DataLock and Ransomware Protection can be enabled in the "GOVERNANCE" mode or "COMPLIANCE" mode. For Azure, DataLock and Ransomware Protection can be enabled in the "UNLOCKED" mode or "LOCKED" mode.

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

name

string

False

rule

array[rule]

True

sgws-archival

sgws-archival

False

archive-after-days

string

False

object-lock

string

False
Example request 
{
  "name": "string",
  "rule": [
    {
      "label": "string",
      "retention": "string"
    }
  ],
  "sgws-archival": {
    "cloud-storage-pool": {
      "provider": "string",
      "provider-account-id": "string",
      "region": "string",
      "access-key": "string",
      "secret-password": "string",
      "archive-storage-class": "string"
    }
  },
  "archive-after-days": "string",
  "object-lock": "string"
}

Response

Status: 200, Default response
Name Type Required Description

name

string

False
Example response 
{
  "name": "string"
}

Definitions

See Definitions

rule

Name Type Required Description

label

string

False

retention

string

False

cloud-storage-pool

Name Type Required Description

provider

string

True

Cloud provider where the cloud storage pool is hosted

provider-account-id

string

True

Cloud provider account ID where the cloud storage pool is hosted

region

string

True

Cloud provider region where the cloud storage pool is hosted

access-key

string

False

Required input field if the provider is AWS

secret-password

string

False

Required input field if the provider is AWS

archive-storage-class

string

False

Required for AWS to specify which storage class to use for archiving

sgws-archival

Name Type Required Description

cloud-storage-pool

cloud-storage-pool

False

body

Name Type Required Description

name

string

False

rule

array[rule]

True

sgws-archival

sgws-archival

False

archive-after-days

string

False

object-lock

string

False