v1

latestSwagger 2.0BSD-2-Clause2026-07-17198262523.1 KB
VM

Create a new Virtual Machine

Create a new virtual machine with the specified parameters

post/vm

Request body

acpiboolean
apicboolean
bootRomstring
cloudInitboolean
cloudInitDatastring
cloudInitMetaDatastring
cloudInitNetworkConfigstring
cpuCoresinteger required
cpuSocketsinteger required
cpuThreadsinteger required
descriptionstring
extraBhyveOptionsstring[]
ignoreUMSRboolean
isostring
macIdinteger
namestring required
pciDevicesinteger[]
qemuGuestAgentboolean
raminteger required
ridinteger required
serialboolean
startAtBootboolean
startOrderinteger
storageEmulationType'virtio-blk' | 'virtio-9p' | 'ahci-hd' | 'ahci-cd' | 'nvme'
storagePoolstring
storageSizeinteger
storageType'raw' | 'zvol' | 'image' | 'filesystem' | 'none'
switchEmulationTypestring
switchNamestring
timeOffset'utc' | 'localtime' required
tpmEmulationboolean
vncBindstring
vncEnabledboolean
vncPasswordstring
vncPortinteger required
vncResolutionstring
vncWaitboolean

Response

Success

{"stackTrail":"components:schemas:github_com_alchemillahq_sylve_internal.APIResponse-any:properties:data","oasType":"schema","type":"unknown"}
errorstring
messagestring
statusstring