Update a backup policy
Suggest changes
PUT /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/backup-policy
Updates a backup policy in a working environment. This V2 version of the API endpoint facilitates modification of the rule, label, retention, archive-after-days, and StorageGRID archival details which includes cloud storage pool information as well.
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 |
|---|---|---|---|
policyName |
string |
True |
Backup policy name |
rule |
array[rule] |
True |
|
sgws-archival |
False |
||
archive-after-days |
string |
False |
Archive after days value to which the policy will be modified. "never" implies the removal of the archive-after-days property from a backup policy |
Example request
{
"policyName": "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"
}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 |
False |
body
| Name | Type | Required | Description |
|---|---|---|---|
policyName |
string |
True |
Backup policy name |
rule |
array[rule] |
True |
|
sgws-archival |
False |
||
archive-after-days |
string |
False |
Archive after days value to which the policy will be modified. "never" implies the removal of the archive-after-days property from a backup policy |