ALalchemillahq
VM

Create a new Virtual Machine

Changed on

Create a new virtual machine with the specified parameters. A VLAN-filtered switch is usable only when it has a default access VLAN; per-VM VLAN policies are not supported.

post/vm

Request

  • Base URL
    https://sylve.lan:8181/api
  • URL
    https://sylve.lan:8181/api/vm
  • Auth
    API key in header Authorization

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
vncResolutionstring
vncWaitboolean

Response

Created

errorstring
messagestring
statusstring

Changes

  • 9a5026bf9057Revision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • ebd6a3e7d6c7Revision changes
    • info

      endpoint added