Skip to main content

Modify multiple backed up volumes

Contributors

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

Modifies multiple backed-up volumes in a specific working environment. This API endpoint modifies the volume state, backup-policy, backup policy rule and 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

authorization

string

header

True

User token

x-agent-id

string

header

True

Request identifier

Request Body

Name Type Required Description

volume

array[volume]

True

Example request
{
  "volume": {
  }
}

Response

Status: 202, Default response
Name Type Required Description

job-id

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

volume

Name Type Required Description

state

string

False

file-system-id

string

True

backup-policy

backup-policy

False

body

Name Type Required Description

volume

array[volume]

True