List Jails

GET

/jail

const url = 'https://sylve.lan:8181/api/jail';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Retrieve all configured jails

Authorizations

BearerAuth

Responses

200

Success

application/json

object

data

Array<object>

object

additionalOptions

string

allowedOptions

Array<string>

cleanEnvironment

boolean

cores

integer

cpuSet

Array<integer>

createdAt

string

ctId

integer

description

string

devfsRuleset

string

execTimeout

integer

fstab

string

hostname

string

integer

inheritIPv4

boolean

inheritIPv6

boolean

intentionallyStopped

boolean

jailHooks

Array<object>

object

enabled

boolean

integer

jid

integer

phase

string

Allowed values: prestart start poststart prestop stop poststop

script

string

memory

integer

metadataEnv

string

metadataMeta

string

name

string

networks

Array<object>

object

defaultGateway

boolean

dhcp

boolean

integer

ipv4GwId

integer

ipv4GwObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

ipv4Id

integer

ipv4Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

ipv6GwId

integer

ipv6GwObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

ipv6Id

integer

ipv6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

jid

integer

macId

integer

macObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

manualSwitch

object

bridge

string

createdAt

string

integer

name

string

updatedAt

string

name

string

slaac

boolean

standardSwitch

object

address

string

address6

string

address6Id

integer

address6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

addressId

integer

addressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

bridgeMacMode

string

bridgeMacObject

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

bridgeMacObjectId

integer

bridgeMacSourcePort

string

bridgeName

string

createdAt

string

defaultRoute

DefaultRoute owns the IPv4 default route for static or DHCP addressing.

boolean

defaultRoute6

DefaultRoute6 owns the IPv6 default route for static or SLAAC addressing.

boolean

dhcp

boolean

disableBridgeOffloads

DisableBridgeOffloads keeps FreeBSD from changing bridge-member capabilities as transient tap and epair interfaces come and go. Sorts flapping issues (Please tell @hayzam if you faced flapping before/after enabling this option).

boolean

disableIPv6

boolean

gateway6AddressId

integer

gateway6AddressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

gateway6Manual

string

gatewayAddressId

integer

gatewayAddressObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

gatewayManual

string

integer

mtu

integer

name

string

network6Id

integer

network6Manual

string

network6Obj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

networkId

integer

networkManual

string

networkObj

object

autoUpdate

boolean

createdAt

string

description

string

entries

Array<object>

object

createdAt

string

integer

objectId

integer

updatedAt

string

value

IP, CIDR, port, country code, FQDN, etc.

string

integer

isUsed

boolean

isUsedBy

“”, “dhcp” for now

string

lastRefreshAt

string

lastRefreshError

string

name

string

refreshIntervalSeconds

integer

resolutionChecksum

string

resolutions

Array<object>

object

createdAt

string

integer

objectId

integer

resolvedIp

Deprecated mirror for resolved IP entries

string

resolvedValue

string

updatedAt

string

sourceChecksum

string

type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string

updatedAt

string

ports

Array<object>

object

integer

name

string

switch

object recursive

switchId

integer

private

boolean

slaac

boolean

updatedAt

string

vlan

integer

switchId

integer

switchType

string

vlan

integer

resolvConf

string

resourceLimits

boolean

snapshots

Array<object>

object

createdAt

string

ctId

integer

description

string

integer

jid

integer

name

string

parentSnapshotId

integer

rootDataset

string

snapshotName

string

updatedAt

string

startAtBoot

boolean

startLogs

string

startOrder

integer

startedAt

string

stopLogs

string

stoppedAt

string

storages

Array<object>

object

guid

string

integer

isBase

boolean

jid

integer

name

string

pool

string

type

string

Allowed values: freebsd linux

updatedAt

string

wol

boolean

error

string

message

string

status

string

Example

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

401

Unauthorized

application/json

object

data

error

string

message

string

status

string

Example^generated

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

500

Internal Server Error

application/json

object

data

error

string

message

string

status

string

Example^generated

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

List Jails

Authorizations

Responses

200

Example

401

Examplegenerated

500

Examplegenerated

Example^generated

Example^generated