/
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
mDNS
6
Network
72
Notifications
17
Samba
8
System
19
Tasks
6
Users
9
Utilities
19
VM
50
get
/vm
List all Virtual Machines
post
/vm
Create a new Virtual Machine
get
/vm/simple
List all VMs (Simple)
get
/vm/simple/{rid}
Get a simple Virtual Machine by RID
get
/vm/templates
List VM templates
get
/vm/templates/{templateId}
Get a VM template
delete
/vm/templates/{templateId}
Delete a VM template
post
/vm/templates/{templateId}/vms
Create VMs from a template
get
/vm/{rid}
Get a Virtual Machine by RID
delete
/vm/{rid}
Remove a Virtual Machine
post
/vm/{rid}/actions/{action}
Queue a Virtual Machine lifecycle action
get
/vm/{rid}/console
Open a VM serial console WebSocket
patch
/vm/{rid}/description
Edit a Virtual Machine's description
get
/vm/{rid}/domain
Get a Virtual Machine's Domain
post
/vm/{rid}/domain/reinitialize
Reinitialize an orphaned Virtual Machine's libvirt configuration
get
/vm/{rid}/guest-agent
Get virtual machine guest-agent information
put
/vm/{rid}/hardware/cpu
Replace virtual machine CPU configuration
put
/vm/{rid}/hardware/pci-devices
Replace virtual machine PCI passthrough configuration
put
/vm/{rid}/hardware/ram
Replace virtual machine RAM configuration
put
/vm/{rid}/hardware/vnc
Replace virtual machine VNC configuration
get
/vm/{rid}/logs
Get VM Logs
post
/vm/{rid}/migrations
Queue a Virtual Machine migration
patch
/vm/{rid}/name
Edit a Virtual Machine's name
post
/vm/{rid}/networks
Attach network to a virtual machine
delete
/vm/{rid}/networks/{networkId}
Detach network from a virtual machine
patch
/vm/{rid}/networks/{networkId}
Update virtual machine network
put
/vm/{rid}/options/boot-order
Replace virtual machine automatic-start configuration
put
/vm/{rid}/options/boot-rom
Replace virtual machine boot ROM configuration
put
/vm/{rid}/options/clock
Replace virtual machine clock configuration
put
/vm/{rid}/options/cloud-init
Replace virtual machine cloud-init configuration
put
/vm/{rid}/options/extra-bhyve-options
Replace virtual machine extra bhyve options
put
/vm/{rid}/options/ignore-umsrs
Replace virtual machine unknown-MSR handling
put
/vm/{rid}/options/qemu-guest-agent
Replace virtual machine QEMU Guest Agent configuration
put
/vm/{rid}/options/serial-console
Replace virtual machine serial-console configuration
put
/vm/{rid}/options/shutdown-wait-time
Replace virtual machine shutdown wait time
put
/vm/{rid}/options/tpm
Replace virtual machine TPM-emulation configuration
put
/vm/{rid}/options/wol
Replace virtual machine Wake-on-LAN configuration
delete
/vm/{rid}/registration
Purge an orphaned Virtual Machine registration
get
/vm/{rid}/snapshots
List VM snapshots
post
/vm/{rid}/snapshots
Create a VM snapshot
delete
/vm/{rid}/snapshots/{snapshotId}
Delete a VM snapshot
post
/vm/{rid}/snapshots/{snapshotId}/rollback
Roll back a VM snapshot
get
/vm/{rid}/stats
Get Initial VM Statistics
get
/vm/{rid}/stats/{step}
Get VM Statistics
post
/vm/{rid}/storage
Attach storage to a virtual machine
post
/vm/{rid}/storage/from-image
Create virtual machine storage from a disk image
delete
/vm/{rid}/storage/{storageId}
Delete a virtual machine storage attachment
patch
/vm/{rid}/storage/{storageId}
Update virtual machine storage
post
/vm/{rid}/templates
Capture a VM as a template
get
/vnc/{port}
Open a VM VNC WebSocket
ZFS
35
VM
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Queue a Virtual Machine lifecycle action
post
/vm/{rid}/actions/{action}
Aug 12, 2026
9a5026bf9057
Revision changes
info
endpoint added