Skip to content
SYLVE

Roll back a VM snapshot

POST
/vm/{rid}/snapshots/{snapshotId}/rollback
curl --request POST \
  --url https://sylve.lan:8181/api/vm/1/snapshots/1/rollback \
  --header 'Authorization: <Authorization>'

Stop the VM if needed, roll every recorded VM ZFS root back to the selected snapshot while destroying newer ZFS snapshots, restore the saved configuration, and attempt to restore the prior running state

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Virtual Machine RID

snapshotId
required
integer
>= 1

VM Snapshot ID

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
newerSnapshotsDestroyed
integer
restarted
boolean
warnings
Array<string>
wasRunning
boolean
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "newerSnapshotsDestroyed": 1,
    "restarted": true,
    "warnings": [
      "example"
    ],
    "wasRunning": true
  },
  "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"
}