ALalchemillahq
VM

Remove a Virtual Machine

Remove a virtual machine by RID. Set force=true for best-effort forced removal; normal removal requires all three cleanup flags.

delete/vm/{rid}

Request

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

Path parameters

ridinteger required

Virtual Machine RID

Query parameters

deletemacsboolean

Delete unused VM MAC objects (required for normal removal; defaults to true for forced removal)

deleterawdisksboolean

Delete raw-disk datasets (required for normal removal)

deletevolumesboolean

Delete volume datasets (required for normal removal)

forceboolean

Use best-effort forced removal

Response

Success

errorstring
messagestring
statusstring

Changes

No recorded changes to this operation across all 70 revisions of this API.