Skip to navigation
API Referencevms

Resize the root disk of a virtual machine

Resizes the root disk of a virtual machine. The new size must be larger than the current root disk size.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

idstringRequired
ID of the virtual machine

Request

This endpoint expects an object.
sizeGbintegerRequired>=10
The new size of the root disk in GB. Must be larger than the current root disk size.
rebootbooleanOptionalDefaults to false
Whether to automatically reboot the VM after the resize completes. Only applies when the VM is running. A reboot is required for the OS to recognize the new disk size.

Response

The disk resize operation has been initiated
idstringformat: "uuid"
Virtual machine ID.
statusstring
Transitional state during the resize.
rebootInitiatedboolean

True when the VM was running and reboot=true, so the new disk size was applied via a reboot. False otherwise (VM was already stopped, or reboot=false, or the reboot step failed — see message).

messagestringOptional

Present only when the disk resize succeeded but the follow-up reboot failed; surfaces a remediation hint to the caller.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error