Get a jail template

GET

/jail/templates/{templateId}

curl --request GET \
  --url https://sylve.lan:8181/api/jail/templates/1 \
  --header 'Authorization: <Authorization>'

Retrieve a jail template by its template ID

Authorizations

• BearerAuth

Parameters

Path Parameters

templateId

required

integer

>= 1

Jail Template ID

Responses

200

Success

Media typeapplication/json

object

data

object

additionalOptions

string

allowedOptions

Array<string>

cleanEnvironment

boolean

cores

integer

createdAt

string

devfsRuleset

string

execTimeout

integer

fstab

string

hooks

Array<object>

object

enabled

boolean

phase

string

Allowed values: prestart start poststart prestop stop poststop

script

string

id

integer

inheritIPv4

boolean

inheritIPv6

boolean

memory

integer

metadataEnv

string

metadataMeta

string

name

string

networks

Array<object>

object

defaultGateway

boolean

dhcp

boolean

name

string

slaac

boolean

switchId

integer

switchType

string

vlanPolicy

object

mode

string

taggedVlans

Array<integer>

untaggedVlan

integer

pool

string

resolvConf

string

resourceLimits

boolean

rootDataset

string

sourceJailCtid

integer

sourceJailName

string

type

string

Allowed values: freebsd linux

updatedAt

string

wol

boolean

error

string

message

string

status

string

Example

{
  "data": {
    "hooks": [
      {
        "phase": "prestart"
      }
    ],
    "type": "freebsd"
  }
}

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

404

Not Found

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