Skip to main content
PATCH
Error

Authorizations

X-API-Key
string
header
required

Path Parameters

volume
string
required

Volume ID or name

Body

application/json
description
string | null

Description replaces the description; null or an empty string clears it.

Maximum string length: 1024
labels
object | null

Labels replaces every label; null or an empty object clears them.

Response

OK

attachments
object[]
created_at
string<date-time>
created_by
string
description
string
id
string
labels
object
name
string
size_bytes
integer
source_volume_id
string
status
string
status_message
string
updated_at
string<date-time>
updated_by
string