Skip to main content

Modify a backed up volume

Contributors

PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}

Modifies a specified backed up volume. You can use this API endpoint to modify the volume state, backup policy, backup policy rule-retention, and archive-after-days parameters.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

Working environment ID

volumeId

string

path

True

Volume ID

authorization

string

header

True

User token

x-agent-id

string

header

True

Request identifier

Request Body

Name Type Required Description

state

string

False

backup-policy

backup-policy

False

Example request
{
  "state": "PAUSE",
  "backup-policy": {
    "rule": {
    },
    "object-lock": "NONE"
  }
}

Response

Status: 200, Default response
Name Type Required Description

state

string

False

Definitions

See Definitions

rule

Name Type Required Description

label

string

False

retention

string

False

backup-policy

Name Type Required Description

name

string

False

rule

array[rule]

False

archive-after-days

string

False

object-lock

string

False

body

Name Type Required Description

state

string

False

backup-policy

backup-policy

False