/
AL
alchemillahq
/
Sylve API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 37m ago · Updated 3w ago
View markdown
alchemillahq
Sylve API
post
Create a new Jail
v1
latest
Swagger 2.0
BSD-2-Clause
2026-07-17
198
262
523.1 KB
Authentication
2
Cluster
11
Cluster Internal
1
Disk
5
Groups
5
Health
4
Info
10
jail
1
Jail
29
get
List all Jails
post
Create a new Jail
get
Get a Jail by an Identifier
get
Get Jail Logs
post
Perform Jail Action
post
Create bootstrap
delete
Delete bootstrap
get
List bootstraps
put
Update Jail CPU
put
Edit a Jail's description
put
Update Jail Memory
put
Edit a Jail's name
put
Edit Network Switch for Jail
post
Add Network Switch to Jail
put
Set Network Inheritance
delete
Delete Network Switch from Jail
get
List all Jails (Simple)
get
Get a Jail by CTID or ID (Simple)
get
List all Jails States
get
Get Jail State
get
Get Jail Statistics
delete
Delete a Jail
put
Modify Additional Options of a Jail
put
Modify Allowed Options of a Jail
put
Modify DevFS rules of a Jail
put
Modify Fstab of a Jail
put
Modify Lifecycle Hooks of a Jail
put
Modify Metadata of a Jail
put
Modify resolv.conf of a Jail
Network
23
Samba
7
system
5
System
19
Users
3
Utilities
12
VM
34
ZFS
27
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
ipv6
integer
ipv6Gw
integer
mac
integer
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
Response
Success
GithubComAlchemillahqSylveInternalAPIResponseAny
required
{"stackTrail":"components:schemas:github_com_alchemillahq_sylve_internal.APIResponse-any:properties:data","oasType":"schema","type":"unknown"}
error
string
message
string
status
string