/
AL
alchemillahq
/
Sylve API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 1h ago · Updated 3d ago
View markdown
alchemillahq
Sylve API
post
Create a new Jail
latest
Swagger 2.0
BSD-2-Clause
raw.githubusercontent.com
2026-08-18
389
592
1.5 MB
7a7bea85004e
Authentication
10
Basic
3
Certificates
10
Cluster
15
Cluster Backups
23
Cluster Internal
1
Cluster Replication
9
Disk
12
Dynamic DNS
5
Events
1
Groups
4
Health
2
Info
18
iSCSI
15
Jail
43
get
List Jails
post
Create a new Jail
get
List bootstraps
post
Create bootstrap
delete
Delete bootstrap
get
List Jails (Simple)
get
Get a Jail (Simple)
get
List jail templates
get
Get a jail template
delete
Delete a jail template
post
Create jails from a template
get
Get a Jail
delete
Delete a Jail
post
Queue a Jail lifecycle action
get
Open a jail console WebSocket
patch
Edit a Jail's description
put
Update jail CPU limit
put
Update jail RAM limit
put
Set jail resource limits
get
Get jail logs
post
Queue a Jail migration
patch
Edit a Jail's name
put
Set jail network inheritance
post
Attach a network to a jail
delete
Detach a network from a jail
patch
Update a jail network
put
Replace additional jail.conf options
put
Replace allowed jail options
put
Replace jail automatic-start configuration
put
Replace jail DevFS rules
put
Replace jail fstab configuration
put
Replace jail lifecycle hooks
put
Replace jail metadata
put
Replace jail resolv.conf configuration
put
Replace jail Wake-on-LAN configuration
get
List jail snapshots
post
Create a jail snapshot
delete
Delete a jail snapshot
post
Roll back a jail snapshot
get
Get jail state
get
Get initial jail statistics
get
Get jail statistics
post
Capture a jail as a template
mDNS
6
Network
61
Notifications
17
Samba
8
System
19
Tasks
5
Users
9
Utilities
16
VM
48
ZFS
29
Jail
Create a new Jail
Create a new jail with the provided configuration
post
/jail
Request body
GithubComAlchemillahqSylveInternalInterfacesServicesJailCreateJailRequest
required
additionalOptions
string
allowedOptions
string[]
base
string
bootstrapName
string
cleanEnvironment
boolean
cores
integer
ctId
integer
required
description
string
devfsRuleset
string
dhcp
boolean
fstab
string
hooks
GithubComAlchemillahqSylveInternalInterfacesServicesJailHooks
hostname
string
inheritIPv4
boolean
inheritIPv6
boolean
ipv4
integer
ipv4Gw
integer
ipv4GwRaw
string
ipv4Raw
string
ipv6
integer
ipv6Gw
integer
ipv6GwRaw
string
ipv6Raw
string
mac
integer
macRaw
string
memory
integer
metadataEnv
string
metadataMeta
string
name
string
required
pool
string
required
resolvConf
string
resourceLimits
boolean
slaac
boolean
startAtBoot
boolean
startOrder
integer
switchName
string
type
'freebsd'
|
'linux'
required
vlan
integer
Response
Created
GithubComAlchemillahqSylveInternalAPIResponseInternalHandlersJailJailCreateResponse
required
data
InternalHandlersJailJailCreateResponse
error
string
message
string
status
string