Volumes

Rename Volume

Rename a volume.

Dispatches VolumeRenameCommand to the volume's master appliance and returns the tracking task (id is the task_id the FE subscribes to). 404 when the volume is unknown, 400 for an invalid or unchanged name, 409 when a rename is already in flight for the volume.

patch/volumes/{volume_id}/name

Request

Path parameters

volume_idstring required

Request body

namestring required

New volume name; trimmed, 1-25 chars.

Response

Volume rename dispatch accepted

idstring uuid required
created_atstring date-time required
resourcestring required
stack_idstring uuid nullable
actionstring required
executor'edge' required
executor_idstring uuid nullable
initiated_by'portal' | 'edge' required
initiator_idstring uuid nullable
activity_log_idstring uuid nullable
reasonstring nullable
state'in_progress' | 'completed' | 'failed' required
last_updated_atstring date-time required
user_acknowledged_atstring date-time nullable
deletion_timestring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.