Skip to main content

Retrieve the volumes for backup activation

GET /vsa/volumes/volumes-for-backup

Retrieves all volumes for backup activation.

Parameters

Name Type In Required Description

workingEnvironmentId

string

query

False

offset

integer

query

False

limit

integer

query

False

search

string

query

False

filterBy

ListFilterByParam

query

False

sortBy

ListSortByParam

query

False

Error

Status: Default, Default response
Name Type Required Description

volumes

array[VolumeForBackupResponse]

True

totalNumberOfVolumes

integer

True

filteredNumberOfVolumes

filteredNumberOfVolumes

False

hasNextPage

hasNextPage

False

allowedValuesForVolumesListFilter

AllowedValuesForVolumesListFilter

False

Definitions

See Definitions

ListFilterByParam

Name Type Required Description

s

string

True

ListSortByParam

Name Type Required Description

s

string

True

Capacity

Name Type Required Description

size

number

True

unit

string

True

VolumeForBackupResponse

Name Type Required Description

name

string

True

uuid

string

False

svmName

string

False

size

Capacity

True

usedSize

Capacity

False

state

string

False

providerVolumeType

string

False

volumeType

string

False

isBackupOn

boolean

True

disableReasonBackup

array[string]

True

filteredNumberOfVolumes

hasNextPage

AllowedValuesForVolumesListFilter

Name Type Required Description

volumeTypes

array[string]

False

diskTypes

array[string]

False

svmNames

array[string]

False

volumeStatus

array[string]

False