Skip to main content

Update a backup policy

Contributors

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

Updates a backup policy in a working environment. This API endpoint facilitates modification of the rule, label, retention, and archive-after-days information.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

Working environment ID

policyName

string

path

True

Backup policy name

authorization

string

header

True

User token

x-agent-id

string

header

True

Request identifier

Request Body

Name Type Required Description

rule

array[rule]

True

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
{
  "rule": [
    {
      "label": "string",
      "retention": "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

body

Name Type Required Description

rule

array[rule]

True

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