Sign in
Jail

Validate a jail creation request

Changed on

Check common settings and root-source compatibility without creating a jail

post/jail/validate

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/jail/validate
  • Auth: API key in header Authorization

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

Response

Validated

dataunknown
errorstring
messagestring
statusstring

Changes