Modify BlueXP backup and recovery service backup configuration

11/21/2024 Contributors

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

Modifies BlueXP backup and recovery backup configuration for a particular working environment synchronously (V2). You can modify the state, backup policy, archive storage class, cloud storage pool, AWS\|Azure\|GCP\|StorageGRID access and secret key, IPspace, maximum transfer rate, and enable auto backup.

Token usage: BlueXP user token.

Parameters

Name	Type	In	Required	Description
accountId	string	path	True	Account ID
workingEnvironmentId	string	path	True	Working environment ID of the source Cloud Volumes ONTAP instance
authorization	string	header	True	User token
x-agent-id	string	header	True	Request identifier

Name

Type

Required

Description

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

Working environment ID of the source Cloud Volumes ONTAP instance

authorization

string

header

True

User token

x-agent-id

string

header

True

Request identifier

Request Body

Name	Type	Required	Description
state	string	False	Updates the SnapMirror relationship state in the working environment to the state specified
backup-policy	backup-policy	False	Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up working environment relationships to use the existing one.
archive-storage-class	string	False	Required for AWS if modifying the storage class or enabling archive for the first time.
auto-backup-enabled	boolean	False	Auto backup all volumes in the 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
delete-yearly-snapshots	boolean	False	Disable the deletion of local yearly Snapshot copies after being transferred to object store
export-existing-snapshots	boolean	False	Export pre-existing Snapshot copies to object storage
ip-space	string	False	IP space for the backed up working environment
aws	aws	False	Access key and secret password for the working environment
gcp	gcp	False	Access key and secret password for the working environment
sgws	sgws	False	Access key and secret password for the working environment

Name

Type

Required

Description

state

string

False

Updates the SnapMirror relationship state in the working environment to the state specified

backup-policy

False

Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up working environment relationships to use the existing one.

archive-storage-class

string

False

Required for AWS if modifying the storage class or enabling archive for the first time.

auto-backup-enabled

boolean

False

Auto backup all volumes in the 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

delete-yearly-snapshots

boolean

False

Disable the deletion of local yearly Snapshot copies after being transferred to object store

export-existing-snapshots

boolean

False

Export pre-existing Snapshot copies to object storage

ip-space

string

False

IP space for the backed up working environment

aws

False

Access key and secret password for the working environment

gcp

False

Access key and secret password for the working environment

sgws

False

Access key and secret password for the working environment

Example request

{
  "state": "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"
      }
    }
  },
  "archive-storage-class": "string",
  "ip-space": "string",
  "aws": {
    "access-key": "string",
    "secret-password": "string"
  },
  "gcp": {
    "access-key": "string",
    "secret-password": "string"
  },
  "sgws": {
    "access-key": "string",
    "secret-password": "string",
    "storage-grid-id": "string"
  }
}

Response

Status: 202, Default response

Name	Type	Required	Description
job-id	string	False

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

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

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

Name

Type

Required

Description

cloud-storage-pool

False

backup-policy

Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up working environment relationships to use the existing one.

Name	Type	Required	Description
name	string	False	Policy name of the existing policy or any custom name with which a new policy needs to be created. If not specified, a policy with the BlueXP backup and recovery default naming convention is created.
rule	array[rule]	False	Specify the rules for a new policy
archive-after-days	string	False
object-lock	string	False
sgws-archival	sgws-archival	False

Name

Type

Required

Description

name

string

False

Policy name of the existing policy or any custom name with which a new policy needs to be created. If not specified, a policy with the BlueXP backup and recovery default naming convention is created.

rule

array[rule]

False

Specify the rules for a new policy

archive-after-days

string

False

object-lock

string

False

sgws-archival

False

aws

Access key and secret password for the working environment

Name	Type	Required	Description
access-key	string	False
secret-password	string	False

Name

Type

Required

Description

access-key

string

False

secret-password

string

False

gcp

Access key and secret password for the working environment

Name	Type	Required	Description
access-key	string	False
secret-password	string	False

Name

Type

Required

Description

access-key

string

False

secret-password

string

False

sgws

Access key and secret password for the working environment

Name	Type	Required	Description
access-key	string	False
secret-password	string	False
storage-grid-id	string	False	StorageGRID ID. Required input field for StorageGRID provider

Name

Type

Required

Description

access-key

string

False

secret-password

string

False

storage-grid-id

string

False

StorageGRID ID. Required input field for StorageGRID provider

body

Name	Type	Required	Description
state	string	False	Updates the SnapMirror relationship state in the working environment to the state specified
backup-policy	backup-policy	False	Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up working environment relationships to use the existing one.
archive-storage-class	string	False	Required for AWS if modifying the storage class or enabling archive for the first time.
auto-backup-enabled	boolean	False	Auto backup all volumes in the 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
delete-yearly-snapshots	boolean	False	Disable the deletion of local yearly Snapshot copies after being transferred to object store
export-existing-snapshots	boolean	False	Export pre-existing Snapshot copies to object storage
ip-space	string	False	IP space for the backed up working environment
aws	aws	False	Access key and secret password for the working environment
gcp	gcp	False	Access key and secret password for the working environment
sgws	sgws	False	Access key and secret password for the working environment

Name

Type

Required

Description

state

string

False

Updates the SnapMirror relationship state in the working environment to the state specified

backup-policy

False

Uses an existing policy or creates a new policy if not found in the list of ONTAP policies and modifies the backed up working environment relationships to use the existing one.

archive-storage-class

string

False

Required for AWS if modifying the storage class or enabling archive for the first time.

auto-backup-enabled

boolean

False

Auto backup all volumes in the 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

delete-yearly-snapshots

boolean

False

Disable the deletion of local yearly Snapshot copies after being transferred to object store

export-existing-snapshots

boolean

False

Export pre-existing Snapshot copies to object storage

ip-space

string

False

IP space for the backed up working environment

aws

False

Access key and secret password for the working environment

gcp

False

Access key and secret password for the working environment

sgws

False

Access key and secret password for the working environment