/
AL
alchemillahq
/
Sylve API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 10h ago
View markdown
alchemillahq
Sylve API
get
Get a Jail (Simple)
Swagger 2.0
BSD-2-Clause
raw.githubusercontent.com
2026-08-22
389
592
1.5 MB
9822c41c8ac0
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
Get a Jail (Simple)
Retrieve the lightweight projection of a jail by its CTID
get
/jail/simple/{ctid}
Path parameters
ctid
integer
required
Jail CTID
Response
Success
GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalInterfacesServicesJailSimpleList
required
data
GithubComAlchemillahqSylveInternalInterfacesServicesJailSimpleList
error
string
message
string
status
string