Skip to main content

Enable BlueXP backup and recovery (v3)

Contributors

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

Enables BlueXP backup and recovery for a specific working environment.The V3 version of the API endpoint enables BlueXP backup and recovery on Cloud Volumes ONTAP on AWS, Azure, Google Cloud, and on-premises ONTAP systems. It checks whether an S3 cloud storage bucket is associated with an account. If a bucket does not exist, it creates a bucket. It creates a backup folder on the S3 cloud object storage bucket in the specified cloud provider or in StorageGRID. It is possible to tier old backup files to archival storage in the required cloud provider. This feature is supported with AWS, Azure, Google Cloud, and StorageGRID. Restoring volumes from backup objects that reside in archival storage also requires that the destination cluster is running ONTAP 9.10.1 or later.

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

provider

string

False

Required input field for an on-premises use case

  • enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3"]

region

string

False

Required input field for an on-premises use case

aws

aws

False

azure

azure

False

gcp

gcp

False

sgws

sgws

False

ontap-s3

ontap-s3

False

bucket

string

False

Optional input

ip-space

string

False

Required input field for an on-premises use case

backup-policy

backup-policy

False

auto-backup-enabled

boolean

False

Auto backup all volumes in working environments

max-transfer-rate

number

False

Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling

export-existing-snapshots

boolean

False

Export pre-existing Snapshot copies to object storage
Example request 
{
  "provider": "string",
  "region": "string",
  "aws": {
    "account-id": "string",
    "access-key": "string",
    "secret-password": "string",
    "kms-key-id": "string",
    "private-endpoint": {
      "id": "string"
    },
    "archive-storage-class": "string"
  },
  "azure": {
    "resource-group": "string",
    "storage-account": "string",
    "subscription": "string",
    "private-endpoint": {
      "subnet": "string"
    },
    "key-vault": {
      "key-vault-id": "string",
      "key-name": "string"
    }
  },
  "gcp": {
    "project-id": "string",
    "access-key": "string",
    "secret-password": "string",
    "kms": {
      "key-ring-id": "string",
      "crypto-key-id": "string"
    }
  },
  "sgws": {
    "storage-grid-id": "string",
    "storage-server": "string",
    "access-key": "string",
    "secret-password": "string"
  },
  "ontap-s3": {
    "storage-server": "string",
    "access-key": "string",
    "secret-password": "string"
  },
  "bucket": "string",
  "ip-space": "string",
  "backup-policy": {
    "name": "string",
    "rule": [
      {
        "label": "string",
        "retention": "string"
      }
    ],
    "archive-after-days": "string",
    "object-lock": "string",
    "sgws-archival": {
      "cloud-storage-pool": {
        "provider": "string",
        "provider-account-id": "string",
        "region": "string",
        "access-key": "string",
        "secret-password": "string",
        "archive-storage-class": "string",
        "resource-group": "string"
      }
    }
  }
}

Response

Status: 202, Default response
Name Type Required Description

job-id

string

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

Definitions

See Definitions

private-endpoint

Name Type Required Description

id

string

False

Optional input field for a private endpoint

aws

Name Type Required Description

account-id

string

False

Required when the provider is AWS

access-key

string

False

Required input field for an on-premises use case

secret-password

string

False

Required input field for an on-premises use case

kms-key-id

string

False

Optional input field for a customer-managed key use case

private-endpoint

private-endpoint

False

archive-storage-class

string

False

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

private-endpoint

Required input field for an on-premises use case for private link configuration

Name Type Required Description

subnet

string

False

Required input field for On-premises private link configuration

key-vault

Name Type Required Description

key-vault-id

string

False

key-name

string

False

azure

Name Type Required Description

resource-group

string

False

Required when the provider is Azure

storage-account

string

False

Required when the provider is Azure

subscription

string

False

Required when the provider is Azure

private-endpoint

private-endpoint

False

Required input field for an on-premises use case for private link configuration

key-vault

key-vault

False

kms

Name Type Required Description

key-ring-id

string

False

crypto-key-id

string

False

gcp

Name Type Required Description

project-id

string

False

Required when the provider is Google Cloud

access-key

string

False

Required input field for an on-premises use case

secret-password

string

False

Required input field for an on-premises use case

kms

kms

False

sgws

Name Type Required Description

storage-grid-id

string

False

StorageGRID ID. Required input field for StorageGRID provider

storage-server

string

False

StorageGRID server URL. Required input field for StorageGRID provider

access-key

string

False

Required input field for an on-premises use case

secret-password

string

False

Required input field for an on-premises use case

ontap-s3

Name Type Required Description

storage-server

string

False

ONTAP S3 server URL. Required input field for ONTAP_S3 provider

access-key

string

False

Required input field for an on-premises use case

secret-password

string

False

Required input field for an on-premises use case

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

resource-group

string

False

Required when the provider is Azure

sgws-archival

Name Type Required Description

cloud-storage-pool

cloud-storage-pool

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

sgws-archival

sgws-archival

False

body

Name Type Required Description

provider

string

False

Required input field for an on-premises use case

  • enum: ["AWS", "AZURE", "GCP", "SGWS", "ONTAP_S3"]

region

string

False

Required input field for an on-premises use case

aws

aws

False

azure

azure

False

gcp

gcp

False

sgws

sgws

False

ontap-s3

ontap-s3

False

bucket

string

False

Optional input

ip-space

string

False

Required input field for an on-premises use case

backup-policy

backup-policy

False

auto-backup-enabled

boolean

False

Auto backup all volumes in working environments

max-transfer-rate

number

False

Modifies node level throttling of an ONTAP cluster. Value to be specified in kilo bytes per second(kbps). A value of 0 implies Unlimited throttling

export-existing-snapshots

boolean

False

Export pre-existing Snapshot copies to object storage