Create a new Jail

POST

/jail

curl --request POST \
  --url https://sylve.lan:8181/api/jail \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "additionalOptions": "example", "allowedOptions": [ "example" ], "base": "example", "bootstrapName": "example", "cleanEnvironment": true, "cores": 1, "ctId": 1, "description": "example", "devfsRuleset": "example", "dhcp": true, "fstab": "example", "hooks": { "poststart": { "enabled": true, "script": "example" }, "poststop": { "enabled": true, "script": "example" }, "prestart": { "enabled": true, "script": "example" }, "prestop": { "enabled": true, "script": "example" }, "start": { "enabled": true, "script": "example" }, "stop": { "enabled": true, "script": "example" } }, "hostname": "example", "inheritIPv4": true, "inheritIPv6": true, "ipv4": 1, "ipv4Gw": 1, "ipv4GwRaw": "example", "ipv4Raw": "example", "ipv6": 1, "ipv6Gw": 1, "ipv6GwRaw": "example", "ipv6Raw": "example", "mac": 1, "macRaw": "example", "memory": 1, "metadataEnv": "example", "metadataMeta": "example", "name": "example", "pool": "example", "resolvConf": "example", "resourceLimits": true, "slaac": true, "startAtBoot": true, "startOrder": 1, "switchName": "example", "type": "freebsd", "vlanPolicy": { "mode": "example", "taggedVlans": [ 1 ], "untaggedVlan": 1 }, "zfsSource": { "dataset": "example", "guid": "example" } }'

Create a new jail with the provided configuration. A network attached to a filtered switch requires an explicit access or trunk VLAN policy.

Authorizations

• BearerAuth

Parameters

Query Parameters

async

boolean

Queue creation as a durable lifecycle task

Request Body

Create Jail Request

Media typeapplication/json

object

additionalOptions

string

allowedOptions

Array<string>

base

string

bootstrapName

string

cleanEnvironment

boolean

cores

integer

ctId

required

integer

description

string

devfsRuleset

string

dhcp

boolean

fstab

string

hooks

object

poststart

object

enabled

boolean

script

string

poststop

object

enabled

boolean

script

string

prestart

object

enabled

boolean

script

string

prestop

object

enabled

boolean

script

string

start

object

enabled

boolean

script

string

stop

object

enabled

boolean

script

string

hostname

string

inheritIPv4

boolean

inheritIPv6

boolean

ipv4

integer

ipv4Gw

integer

ipv4GwRaw

string

ipv4Raw

string

ipv6

integer

ipv6Gw

integer

ipv6GwRaw

string

ipv6Raw

string

mac

integer

macRaw

string

memory

integer

metadataEnv

string

metadataMeta

string

name

required

string

pool

required

string

resolvConf

string

resourceLimits

boolean

slaac

boolean

startAtBoot

boolean

startOrder

integer

switchName

string

type

required

string

Allowed values: freebsd linux

vlanPolicy

object

mode

string

taggedVlans

Array<integer>

untaggedVlan

integer

zfsSource

object

dataset

string

guid

string

Responses

201

Created

Media typeapplication/json

object

data

object

ctId

integer

name

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "ctId": 1,
    "name": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

Headers

Location

string

/api/jail/{ctid}

202

Creation queued

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "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"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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

413

Request Entity Too Large

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

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

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