ALalchemillahq
Jail

Create a new Jail

Changed on

Create a new jail with the provided configuration. A network attached to a filtered switch requires an explicit access or trunk VLAN policy. For existing ZFS roots, zfsSource.mode accepts copy (the API default) or rename. Both include child datasets. Rename requires the source pool and preserves existing snapshots; copy retains the source and does not import snapshot history.

post/jail

Request

  • Base URL
    https://sylve.lan:8181/api
  • URL
    https://sylve.lan:8181/api/jail
  • Auth
    API key in header Authorization

Query parameters

asyncboolean

Queue creation as a durable lifecycle task

Request body

additionalOptionsstring
allowedOptionsstring[]
basestring
bootstrapNamestring
cleanEnvironmentboolean
coresinteger
ctIdinteger required
descriptionstring
devfsRulesetstring
dhcpboolean
fstabstring
hostnamestring
inheritIPv4boolean
inheritIPv6boolean
ipv4integer
ipv4Gwinteger
ipv4GwRawstring
ipv4Rawstring
ipv6integer
ipv6Gwinteger
ipv6GwRawstring
ipv6Rawstring
macinteger
macRawstring
memoryinteger
metadataEnvstring
metadataMetastring
namestring required
poolstring required
resolvConfstring
resourceLimitsboolean
slaacboolean
startAtBootboolean
startOrderinteger
switchNamestring
type'freebsd' | 'linux' required

Example request

{
  "zfsSource": {
    "mode": "rename"
  }
}

Response

Created

errorstring
messagestring
statusstring

Changes

  • ead7013c16a6Revision changes
    • info

      added the new optional query request parameter async

    • info

      added the success response with the status

  • 9a5026bf9057Revision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status