Skip to main content
POST
Start a disk upload
Upload a qcow2 file, then complete it before selecting its disk ID for a VM. The file must include the dependencies described in the VM disk guide.
For a local_proxy target, use Upload disk bytes with the returned disk ID, then complete the upload. If a transfer expires or fails, request a new target with {"disk_id": "<saved-disk-id>"}. Use Delete a disk to discard an unfinished upload.

Authorizations

Authorization
string
header
required

Send an organization API key as a bearer token.

Body

application/json
disk_id
string<uuid>

Reissue an upload for an existing uploaded or imported disk owned by your organization. Omit to create a new pending upload. Created disks cannot be replaced this way.

display_name
string

Required and nonblank when disk_id is omitted. To rename an existing upload, send display_name when completing it.

Response

Start a disk upload.

id
string<uuid>
required

Keep this disk ID for completion or cleanup, even if the transfer fails.

upload_mode
enum<string>
required
Available options:
signed_put,
local_proxy
upload_url
string<uri>
required

Use this URL verbatim. Signed URLs grant temporary upload access; keep them private.

upload_method
enum<string>
required
Available options:
PUT,
POST
upload_headers
object
required

Headers required for the upload transfer.

expires_in_seconds
integer
required

Signed URL lifetime in seconds. If it expires, request a new target for the same disk_id. The local_proxy mode does not enforce this expiry.

Example:

3600