Skip to content
SYLVE

Create a jail snapshot

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

Create a crash-consistent recursive ZFS snapshot for a jail without quiescing it

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Jail CTID

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
ctId
integer
description
string
id
integer
jid
integer
name
string
parentSnapshotId
integer
rootDataset
string
snapshotName
string
updatedAt
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "createdAt": "example",
    "ctId": 1,
    "description": "example",
    "id": 1,
    "jid": 1,
    "name": "example",
    "parentSnapshotId": 1,
    "rootDataset": "example",
    "snapshotName": "example",
    "updatedAt": "example"
  },
  "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"
}

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