Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

volume_namespace
string
required
volume_name
string
required

Body

application/json
expires_at
string<date-time> | null

Time at which the volume expires, in ISO 8601 format, with a UTC offset. It must be in the future and at most ten years ahead. Set it to null to clear the expiration time. A body that sets no field is rejected. When the volume expires, all live versions are deleted, all tags are removed, and the volume disappears from listings. Clearing the expiration time afterward does not restore deleted versions. Each deleted version can be restored until its delete_after time. Setting or clearing the expiration time requires the same permission as deleting the volume.

Example:

"2030-01-01T00:00:00Z"

expected_sequence
integer | null

Revision the volume is expected to be at. When set, the update fails with a conflict if the volume has changed since. Take the value from a volume's sequence, or from volume_sequence.

Required range: x >= 0

Response

200 - application/json
namespace
string
required

Namespace the volume belongs to, in lowercase.

volume
string
required

Name of the volume, in lowercase.

expires_at
string<date-time> | null
required

Volume expiration time in ISO 8601 format. Null when no expiration time is set.

volume_sequence
integer
required

Revision of the volume after the update.