Sign in
Jail

Create a new Jail

Create a new jail with the provided configuration

post/jail

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
vlaninteger

Response

Created

errorstring
messagestring
statusstring

Changes

Changed in 3 of the 42 revisions of this API.27

  • 9a5026bf905716See the full diff
    • ▲

      removed the success response with the status 200

      response-success-status-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the non-success response with the status 413

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the success response with the status 201

      response-success-status-added

  • 0e0247c989901See the full diff
    • ○

      endpoint added

      endpoint-added

  • 2b736ca1b0251See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation