/
AL
alchemillahq
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Authentication
11
Basic
3
Certificates
10
Cluster
17
Cluster Backups
23
Cluster Internal
1
Cluster Replication
9
Container
29
Directory Services
19
Disk
12
Dynamic DNS
5
Events
1
Groups
4
Health
2
Info
18
iSCSI
17
Jail
48
get
/jail
List Jails
post
/jail
Create a new Jail
get
/jail/bootstraps
List bootstraps
post
/jail/bootstraps
Create bootstrap
delete
/jail/bootstraps/{name}
Delete bootstrap
get
/jail/simple
List Jails (Simple)
get
/jail/simple/{ctid}
Get a Jail (Simple)
get
/jail/templates
List jail templates
get
/jail/templates/{templateId}
Get a jail template
delete
/jail/templates/{templateId}
Delete a jail template
post
/jail/templates/{templateId}/jails
Create jails from a template
post
/jail/validate
Validate a jail creation request
get
/jail/zfs-sources
List 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}/console
Open a jail console WebSocket
patch
/jail/{ctid}/description
Edit a Jail's description
get
/jail/{ctid}/guest-info
Get jail guest information
put
/jail/{ctid}/hardware/cpu
Update jail CPU limit
put
/jail/{ctid}/hardware/ram
Update jail RAM limit
put
/jail/{ctid}/hardware/resource-limits
Set jail resource limits
get
/jail/{ctid}/logs
Get jail logs
post
/jail/{ctid}/migrations
Queue a Jail migration
patch
/jail/{ctid}/name
Edit a Jail's name
put
/jail/{ctid}/network/inheritance
Set jail network inheritance
post
/jail/{ctid}/networks
Attach 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-options
Replace additional jail.conf options
put
/jail/{ctid}/options/allowed-options
Replace allowed jail options
put
/jail/{ctid}/options/boot-order
Replace jail automatic-start configuration
put
/jail/{ctid}/options/devfs-rules
Replace jail DevFS rules
put
/jail/{ctid}/options/execution-timeout
Replace jail execution timeout
put
/jail/{ctid}/options/fstab
Replace jail fstab configuration
put
/jail/{ctid}/options/lifecycle-hooks
Replace jail lifecycle hooks
put
/jail/{ctid}/options/metadata
Replace jail metadata
put
/jail/{ctid}/options/resolv-conf
Replace jail resolv.conf configuration
put
/jail/{ctid}/options/wol
Replace jail Wake-on-LAN configuration
get
/jail/{ctid}/root-mountpoint
Resolve a jail root mountpoint
get
/jail/{ctid}/snapshots
List jail snapshots
post
/jail/{ctid}/snapshots
Create a jail snapshot
delete
/jail/{ctid}/snapshots/{snapshotId}
Delete a jail snapshot
post
/jail/{ctid}/snapshots/{snapshotId}/rollback
Roll back a jail snapshot
get
/jail/{ctid}/state
Get jail state
get
/jail/{ctid}/stats
Get initial jail statistics
get
/jail/{ctid}/stats/{step}
Get jail statistics
post
/jail/{ctid}/templates
Capture a jail as a template
mDNS
6
Network
72
Notifications
17
Samba
8
System
19
Tasks
6
Users
9
Utilities
19
VM
50
ZFS
35
Jail
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Edit a Jail's name
patch
/jail/{ctid}/name
Aug 12, 2026
9a5026bf9057
Revision changes
info
endpoint added