/

Docs
History
Schema
Generate

Filter operations

Authentication11

Basic3

Certificates10

Cluster17

Cluster Backups23

Cluster Internal1

Cluster Replication9

Container29

Directory Services19

Disk12

Dynamic DNS5

Events1

Groups4

Health2

Info18

iSCSI17

Jail48

get/jailList Jails
post/jailCreate a new Jail
get/jail/bootstrapsList bootstraps
post/jail/bootstrapsCreate bootstrap
delete/jail/bootstraps/{name}Delete bootstrap
get/jail/simpleList Jails (Simple)
get/jail/simple/{ctid}Get a Jail (Simple)
get/jail/templatesList jail templates
get/jail/templates/{templateId}Get a jail template
delete/jail/templates/{templateId}Delete a jail template
post/jail/templates/{templateId}/jailsCreate jails from a template
post/jail/validateValidate a jail creation request
get/jail/zfs-sourcesList existing jail root datasets
get/jail/{ctid}Get a Jail
delete/jail/{ctid}Delete a Jail
post/jail/{ctid}/actions/{action}Queue a Jail lifecycle action
get/jail/{ctid}/consoleOpen a jail console WebSocket
patch/jail/{ctid}/descriptionEdit a Jail's description
get/jail/{ctid}/guest-infoGet jail guest information
put/jail/{ctid}/hardware/cpuUpdate jail CPU limit
put/jail/{ctid}/hardware/ramUpdate jail RAM limit
put/jail/{ctid}/hardware/resource-limitsSet jail resource limits
get/jail/{ctid}/logsGet jail logs
post/jail/{ctid}/migrationsQueue a Jail migration
patch/jail/{ctid}/nameEdit a Jail's name
put/jail/{ctid}/network/inheritanceSet jail network inheritance
post/jail/{ctid}/networksAttach a network to a jail
delete/jail/{ctid}/networks/{networkId}Detach a network from a jail
patch/jail/{ctid}/networks/{networkId}Update a jail network
put/jail/{ctid}/options/additional-optionsReplace additional jail.conf options
put/jail/{ctid}/options/allowed-optionsReplace allowed jail options
put/jail/{ctid}/options/boot-orderReplace jail automatic-start configuration
put/jail/{ctid}/options/devfs-rulesReplace jail DevFS rules
put/jail/{ctid}/options/execution-timeoutReplace jail execution timeout
put/jail/{ctid}/options/fstabReplace jail fstab configuration
put/jail/{ctid}/options/lifecycle-hooksReplace jail lifecycle hooks
put/jail/{ctid}/options/metadataReplace jail metadata
put/jail/{ctid}/options/resolv-confReplace jail resolv.conf configuration
put/jail/{ctid}/options/wolReplace jail Wake-on-LAN configuration
get/jail/{ctid}/root-mountpointResolve a jail root mountpoint
get/jail/{ctid}/snapshotsList jail snapshots
post/jail/{ctid}/snapshotsCreate a jail snapshot
delete/jail/{ctid}/snapshots/{snapshotId}Delete a jail snapshot
post/jail/{ctid}/snapshots/{snapshotId}/rollbackRoll back a jail snapshot
get/jail/{ctid}/stateGet jail state
get/jail/{ctid}/statsGet initial jail statistics
get/jail/{ctid}/stats/{step}Get jail statistics
post/jail/{ctid}/templatesCapture a jail as a template

mDNS6

Network72

Notifications17

Samba8

System19

Tasks6

Users9

Utilities19

VM50

ZFS35

Jail

Changes to Replace jail execution timeout

put/jail/{ctid}/options/execution-timeout

Aug 23, 2026db005d7577e7 Revision changes
- info
  endpoint added