Skip to content
SYLVE

Create a VM snapshot

POST
/vm/{rid}/snapshots
curl --request POST \
  --url https://sylve.lan:8181/api/vm/1/snapshots \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "name": "example" }'

Create crash-consistent recursive ZFS snapshots for a virtual machine; roots on different pools are captured sequentially and the guest is not quiesced

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”

Snapshot request

Media typeapplication/json
object
description
string
<= 4096 characters
name
required
string
<= 128 characters
Examplegenerated
{
  "description": "example",
  "name": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
data
object
createdAt
string
description
string
id
integer
name
string
parentSnapshotId
integer
rid
integer
rootDatasets
Array<string>
snapshotName
string
updatedAt
string
vmId
integer
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "createdAt": "example",
    "description": "example",
    "id": 1,
    "name": "example",
    "parentSnapshotId": 1,
    "rid": 1,
    "rootDatasets": [
      "example"
    ],
    "snapshotName": "example",
    "updatedAt": "example",
    "vmId": 1
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

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

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