List VM snapshots

GET

/vm/{rid}/snapshots

curl --request GET \
  --url https://sylve.lan:8181/api/vm/1/snapshots \
  --header 'Authorization: <Authorization>'

Retrieve the crash-consistent ZFS snapshot records for a virtual machine

Authorizations

• BearerAuth

Parameters

Path Parameters

rid

required

integer

>= 1

Virtual Machine RID

Responses

200

Success

Media typeapplication/json

object

data

Array<object>

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

Example^generated

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

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}