Skip to content
SYLVE

Delete a Jail

DELETE
/jail/{ctid}
curl --request DELETE \
  --url 'https://sylve.lan:8181/api/jail/1?deletemacs=true&deleterootfs=true' \
  --header 'Authorization: <Authorization>'

Delete a jail by its CTID, optionally deleting unused MAC objects and its root filesystem

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Jail CTID

Query Parameters

Section titled “Query Parameters”
deletemacs
required
boolean

Delete unused jail MAC objects

deleterootfs
required
boolean

Delete the jail root filesystem

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
retainedDatasets
Array<string>
warnings
Array<string>
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "retainedDatasets": [
      "example"
    ],
    "warnings": [
      "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"
}

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