---
title: "List all Jails"
method: GET
path: "/jail"
tags: ["Jail"]
---

# List all Jails

`GET /jail`

Retrieve a list of all jails

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseArrayGithubComAlchemillahqSylveInternalDbModelsJailJail
  - `data` GithubComAlchemillahqSylveInternalDbModelsJailJail[]
    - `additionalOptions` string
    - `allowedOptions` string[]
    - `cleanEnvironment` boolean
    - `cores` integer
    - `cpuSet` integer[]
    - `createdAt` string
    - `ctId` integer
    - `description` string
    - `devfsRuleset` string
    - `fstab` string
    - `hostname` string
    - `id` integer
    - `inheritIPv4` boolean
    - `inheritIPv6` boolean
    - `jailHooks` GithubComAlchemillahqSylveInternalDbModelsJailJailHooks[]
      - `enabled` boolean
      - `id` integer
      - `jid` integer
      - `phase` 'prestart' | 'start' | 'poststart' | 'prestop' | 'stop' | 'poststop'
      - `script` string
    - `memory` integer
    - `metadataEnv` string
    - `metadataMeta` string
    - `name` string
    - `networks` GithubComAlchemillahqSylveInternalDbModelsJailNetwork[]
      - `defaultGateway` boolean
      - `dhcp` boolean
      - `id` integer
      - `ipv4GwId` integer
      - `ipv4GwObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `ipv4Id` integer
      - `ipv4Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `ipv6GwId` integer
      - `ipv6GwObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `ipv6Id` integer
      - `ipv6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `jid` integer
      - `macId` integer
      - `macObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `manualSwitch` GithubComAlchemillahqSylveInternalDbModelsNetworkManualSwitch
        - `bridge` string
        - `createdAt` string
        - `id` integer
        - `name` string
        - `updatedAt` string
      - `name` string
      - `slaac` boolean
      - `standardSwitch` GithubComAlchemillahqSylveInternalDbModelsNetworkStandardSwitch
        - `address` string
        - `address6` string
        - `address6Id` integer
        - `address6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `addressId` integer
        - `addressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `bridgeName` string
        - `createdAt` string
        - `defaultRoute` boolean
        - `dhcp` boolean
        - `disableIPv6` boolean
        - `gateway6AddressId` integer
        - `gateway6AddressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `gatewayAddressId` integer
        - `gatewayAddressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `id` integer
        - `mtu` integer
        - `name` string
        - `network6Id` integer
        - `network6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `networkId` integer
        - `networkObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
          - `autoUpdate` boolean
          - `createdAt` string
          - `description` string
          - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `updatedAt` string
            - `value` string — IP, CIDR, port, country code, FQDN, etc.
          - `id` integer
          - `isUsed` boolean
          - `isUsedBy` string — "", "dhcp" for now
          - `lastRefreshAt` string
          - `lastRefreshError` string
          - `name` string
          - `refreshIntervalSeconds` integer
          - `resolutionChecksum` string
          - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
            - `createdAt` string
            - `id` integer
            - `objectId` integer
            - `resolvedIp` string — deprecated mirror for resolved IP entries
            - `resolvedValue` string
            - `updatedAt` string
          - `sourceChecksum` string
          - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
          - `updatedAt` string
        - `ports` GithubComAlchemillahqSylveInternalDbModelsNetworkNetworkPort[]
          - `id` integer
          - `name` string
          - `switch` GithubComAlchemillahqSylveInternalDbModelsNetworkStandardSwitch — recursive
          - `switchId` integer
        - `private` boolean
        - `slaac` boolean
        - `updatedAt` string
        - `vlan` integer
      - `switchId` integer
      - `switchType` string
    - `resolvConf` string
    - `resourceLimits` boolean
    - `snapshots` GithubComAlchemillahqSylveInternalDbModelsJailJailSnapshot[]
      - `createdAt` string
      - `ctId` integer
      - `description` string
      - `id` 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` GithubComAlchemillahqSylveInternalDbModelsJailStorage[]
      - `guid` string
      - `id` integer
      - `isBase` boolean
      - `jid` integer
      - `name` string
      - `pool` string
    - `type` 'freebsd' | 'linux'
    - `updatedAt` string
    - `wol` boolean
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.net/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.net/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alchemillahq/sylve-api/revisions/950e51f8af98/schema)