/
AL
alchemillahq
/
Sylve API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 1h ago · Updated 4h ago
View markdown
alchemillahq
Sylve API
get
Get a Virtual Machine by RID
latest
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
mDNS
6
Network
61
Notifications
17
Samba
8
System
19
Tasks
5
Users
9
Utilities
16
VM
48
get
List all Virtual Machines
post
Create a new Virtual Machine
get
List all VMs (Simple)
get
Get a simple Virtual Machine by RID
get
List VM templates
get
Get a VM template
delete
Delete a VM template
post
Create VMs from a template
get
Get a Virtual Machine by RID
delete
Remove a Virtual Machine
post
Queue a Virtual Machine lifecycle action
get
Open a VM serial console WebSocket
patch
Edit a Virtual Machine's description
get
Get a Virtual Machine's Domain
get
Get virtual machine guest-agent information
put
Replace virtual machine CPU configuration
put
Replace virtual machine PCI passthrough configuration
put
Replace virtual machine RAM configuration
put
Replace virtual machine VNC configuration
get
Get VM Logs
post
Queue a Virtual Machine migration
patch
Edit a Virtual Machine's name
post
Attach network to a virtual machine
delete
Detach network from a virtual machine
patch
Update virtual machine network
put
Replace virtual machine automatic-start configuration
put
Replace virtual machine boot ROM configuration
put
Replace virtual machine clock configuration
put
Replace virtual machine cloud-init configuration
put
Replace virtual machine extra bhyve options
put
Replace virtual machine unknown-MSR handling
put
Replace virtual machine QEMU Guest Agent configuration
put
Replace virtual machine serial-console configuration
put
Replace virtual machine shutdown wait time
put
Replace virtual machine TPM-emulation configuration
put
Replace virtual machine Wake-on-LAN configuration
delete
Purge an orphaned Virtual Machine registration
get
List VM snapshots
post
Create a VM snapshot
delete
Delete a VM snapshot
post
Roll back a VM snapshot
get
Get Initial VM Statistics
get
Get VM Statistics
post
Attach storage to a virtual machine
delete
Detach storage from a virtual machine
patch
Update virtual machine storage
post
Capture a VM as a template
get
Open a VM VNC WebSocket
ZFS
29
VM
Get a Virtual Machine by RID
Retrieve a virtual machine by its resource ID (RID)
get
/vm/{rid}
Path parameters
rid
integer
required
Virtual Machine RID
Response
Success
GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalDbModelsVmVM
required
data
GithubComAlchemillahqSylveInternalDbModelsVmVM
error
string
message
string
status
string