Skip to content
SYLVE

Attach storage to a virtual machine

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

Create or import and attach a storage device to a shut-off virtual machine

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”

Storage attachment

Media typeapplication/json
object
attachType
required
string
Allowed values: import new
bootOrder
integer
dataset
string
downloadUUID
string
emulation
required
string
Allowed values: virtio-blk virtio-9p ahci-hd ahci-cd nvme
filesystemTarget
string
name
string
pool
string
rawPath
string
readOnly
boolean
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"
}