Skip to content
SYLVE

Create virtual machine storage from a disk image

POST
/vm/{rid}/storage/from-image
curl --request POST \
  --url https://sylve.lan:8181/api/vm/1/storage/from-image \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "bootOrder": 1, "downloadUUID": "example", "emulation": "virtio-blk", "name": "example", "pool": "example", "recordSize": 1, "size": 1, "storageType": "raw", "volBlockSize": 1 }'

Copy or convert a completed Downloader disk image into a writable managed RAW file or ZFS volume and attach it to a shut-off virtual machine. The source download remains unchanged. Omit size to use the image’s virtual capacity, or specify a larger size in bytes; guest partitions and filesystems are not expanded automatically. Installer ISOs and images with external backing files are rejected. Compressed images must be extracted first. Storage topology changes are blocked while the VM is protected by replication.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
rid
required
integer
>= 1

Virtual Machine RID

Request Body

Section titled “Request Body”

Writable disk image import

Media typeapplication/json
object
bootOrder
integer
downloadUUID
required
string
emulation
required
string
Allowed values: virtio-blk virtio-9p ahci-hd ahci-cd nvme
name
required
string
pool
required
string
recordSize
integer
size
integer
storageType
required
string
Allowed values: raw zvol image filesystem none
volBlockSize
integer

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
data
object
bootOrder
integer
dataset
object
guid
string
id
integer
name
string
pool
string
datasetId
integer
emulation
string
Allowed values: virtio-blk virtio-9p ahci-hd ahci-cd nvme
enable
boolean
filesystemTarget
string
id
integer
name
string
pool
string
readOnly
boolean
recordSize
integer
size
integer
type
string
Allowed values: raw zvol image filesystem
uuid
string
vmId
integer
volBlockSize
integer
error
string
message
string
status
string
Example
{
  "data": {
    "emulation": "virtio-blk",
    "type": "raw"
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}