/

Docs
History
Schema
Generate

Filter operations

Authentication11

Basic3

Certificates10

Cluster17

Cluster Backups23

Cluster Internal1

Cluster Replication9

Container29

Directory Services19

Disk12

Dynamic DNS5

Events1

Groups4

Health2

Info18

iSCSI17

Jail48

mDNS6

Network72

Notifications17

Samba8

System19

Tasks6

Users9

Utilities19

VM50

get/vmList all Virtual Machines
post/vmCreate a new Virtual Machine
get/vm/simpleList all VMs (Simple)
get/vm/simple/{rid}Get a simple Virtual Machine by RID
get/vm/templatesList VM templates
get/vm/templates/{templateId}Get a VM template
delete/vm/templates/{templateId}Delete a VM template
post/vm/templates/{templateId}/vmsCreate 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}/consoleOpen a VM serial console WebSocket
patch/vm/{rid}/descriptionEdit a Virtual Machine's description
get/vm/{rid}/domainGet a Virtual Machine's Domain
post/vm/{rid}/domain/reinitializeReinitialize an orphaned Virtual Machine's libvirt configuration
get/vm/{rid}/guest-agentGet virtual machine guest-agent information
put/vm/{rid}/hardware/cpuReplace virtual machine CPU configuration
put/vm/{rid}/hardware/pci-devicesReplace virtual machine PCI passthrough configuration
put/vm/{rid}/hardware/ramReplace virtual machine RAM configuration
put/vm/{rid}/hardware/vncReplace virtual machine VNC configuration
get/vm/{rid}/logsGet VM Logs
post/vm/{rid}/migrationsQueue a Virtual Machine migration
patch/vm/{rid}/nameEdit a Virtual Machine's name
post/vm/{rid}/networksAttach 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-orderReplace virtual machine automatic-start configuration
put/vm/{rid}/options/boot-romReplace virtual machine boot ROM configuration
put/vm/{rid}/options/clockReplace virtual machine clock configuration
put/vm/{rid}/options/cloud-initReplace virtual machine cloud-init configuration
put/vm/{rid}/options/extra-bhyve-optionsReplace virtual machine extra bhyve options
put/vm/{rid}/options/ignore-umsrsReplace virtual machine unknown-MSR handling
put/vm/{rid}/options/qemu-guest-agentReplace virtual machine QEMU Guest Agent configuration
put/vm/{rid}/options/serial-consoleReplace virtual machine serial-console configuration
put/vm/{rid}/options/shutdown-wait-timeReplace virtual machine shutdown wait time
put/vm/{rid}/options/tpmReplace virtual machine TPM-emulation configuration
put/vm/{rid}/options/wolReplace virtual machine Wake-on-LAN configuration
delete/vm/{rid}/registrationPurge an orphaned Virtual Machine registration
get/vm/{rid}/snapshotsList VM snapshots
post/vm/{rid}/snapshotsCreate a VM snapshot
delete/vm/{rid}/snapshots/{snapshotId}Delete a VM snapshot
post/vm/{rid}/snapshots/{snapshotId}/rollbackRoll back a VM snapshot
get/vm/{rid}/statsGet Initial VM Statistics
get/vm/{rid}/stats/{step}Get VM Statistics
post/vm/{rid}/storageAttach storage to a virtual machine
post/vm/{rid}/storage/from-imageCreate 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}/templatesCapture a VM as a template
get/vnc/{port}Open a VM VNC WebSocket

ZFS35

VM

Changes to Attach network to a virtual machine

post/vm/{rid}/networks

Aug 12, 20269a5026bf9057 Revision changes
- info
  endpoint added