Sign in

v4

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-016433145.8 KB
volumes
control

Update Volume

Update a volume TODO: verify, that parameter are quoted correct

patch/control/volumes/{volume_name}

Path parameters

volume_namestring required
Example:Full-1742

Request body

poolstring
slotinteger
volstatusstring
volretentionstring
actiononpurgestring
recycle'yes' | 'no'

An enumeration.

inchanger'yes' | 'no'

An enumeration.

maxvolbytesstring
maxvolfilesinteger
maxvoljobsinteger
enabled'yes' | 'no'

An enumeration.

recyclepoolstring

Example request

{
  "pool": "Full",
  "volstatus": "Archive",
  "volretention": "1 month",
  "maxvolbytes": "20G",
  "recyclepool": "Scratch"
}

Response

Successful Response

{"stackTrail":"paths:/control/volumes/{volume_name}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}