Skip to content
SYLVE

Update virtual machine storage

PATCH
/vm/{rid}/storage/{storageId}
curl --request PATCH \
  --url https://sylve.lan:8181/api/vm/1/storage/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "bootOrder": 1, "emulation": "virtio-blk", "enable": true, "filesystemTarget": "example", "name": "example", "readOnly": true, "size": 1 }'

Partially update an attached storage device on 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

storageId
required
integer
>= 1

Storage ID

Request Body

Section titled “Request Body”

Storage changes

Media typeapplication/json
object
bootOrder
integer
emulation
string
Allowed values: virtio-blk virtio-9p ahci-hd ahci-cd nvme
enable
boolean
filesystemTarget
string
name
string
readOnly
boolean
size
integer

Responses

Section titled “Responses”

200

Section titled “200”

Success

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"
}