Skip to content

Create jails from a template

POST
/jail/templates/{templateId}/jails
curl --request POST \
--url https://sylve.lan:8181/api/jail/templates/1/jails \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "count": 1, "ctid": 1, "mode": "example", "name": "example", "namePrefix": "example", "pool": "example", "startCtid": 1 }'

Validate and queue creation of one or more jails from a jail template

templateId
required
integer
>= 1

Jail Template ID

Jail template instantiation request

Media typeapplication/json
object
count
integer
ctid
integer
mode
string
name
string
namePrefix
string
pool
string
startCtid
integer
Examplegenerated
{
"count": 1,
"ctid": 1,
"mode": "example",
"name": "example",
"namePrefix": "example",
"pool": "example",
"startCtid": 1
}

Accepted

Media typeapplication/json
object
data
object
action
string
outcome
string
taskId
integer
templateId
integer
error
string
message
string
status
string
Examplegenerated
{
"data": {
"action": "example",
"outcome": "example",
"taskId": 1,
"templateId": 1
},
"error": "example",
"message": "example",
"status": "example"
}

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}