Skip to main content

Enable BlueXP backup and recovery (v2)

Contributors

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

Enables BlueXP backup and recovery for a specified working environment synchronously (V2 version). This endpoint enables BlueXP backup and recovery on Cloud Volumes ONTAP on AWS, Azure, Google Cloud, and on-premises ONTAP systems. It checks and retrieves storage account details created for a specified account on the selected cloud provider. If an S3 object store bucket does not exist, it creates the bucket. Then it configures an object store on ONTAP and also creates a SnapMirror policy if the chosen SnapMirror policy does not exist.

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

account-id

string

False

Required when the provider is AWS for an on-premises use case

resource-group

string

False

Required when the provider is Azure for an on-premises use case

storage-account

string

False

Required when the provider is Azure for an on-premises use case

subscription

string

False

Required when the provider is Azure for an on-premises use case

project-id

string

False

Required when the provider is GCP for an on-premises use case

bucket

string

False

Optional input field

region

string

False

Required input field for On-premises

provider

string

False

Required input field for an on-premises use case

storage-server

string

False

StorageGRID server URL. Required input field for StorageGRID provider

ip-space

string

False

Required input field for an on-premises use case

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

azure-key-vault

azure-key-vault

False

backup-policy

backup-policy

False
Example request 
{
  "account-id": "string",
  "resource-group": "string",
  "storage-account": "string",
  "subscription": "string",
  "project-id": "string",
  "bucket": "string",
  "region": "string",
  "provider": "string",
  "storage-server": "string",
  "ip-space": "string",
  "access-key": "string",
  "secret-password": "string",
  "azure-key-vault": {
    "key-vault-id": "string",
    "key-name": "string"
  },
  "backup-policy": {
    "name": "string",
    "rule": [
      {
        "label": "string",
        "retention": "string"
      }
    ]
  }
}

Response

Status: 202, Default response
Name Type Required Description

job-id

string

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

Definitions

See Definitions

azure-key-vault

Name Type Required Description

key-vault-id

string

False

key-name

string

False

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

body

Name Type Required Description

account-id

string

False

Required when the provider is AWS for an on-premises use case

resource-group

string

False

Required when the provider is Azure for an on-premises use case

storage-account

string

False

Required when the provider is Azure for an on-premises use case

subscription

string

False

Required when the provider is Azure for an on-premises use case

project-id

string

False

Required when the provider is GCP for an on-premises use case

bucket

string

False

Optional input field

region

string

False

Required input field for On-premises

provider

string

False

Required input field for an on-premises use case

storage-server

string

False

StorageGRID server URL. Required input field for StorageGRID provider

ip-space

string

False

Required input field for an on-premises use case

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

azure-key-vault

azure-key-vault

False

backup-policy

backup-policy

False