Virtual machines
Force a virtual machine off
Pull the plug without asking the guest, which can lose data the guest has not written yet. Requires the **operator** role.
udon_session<token>
In: cookie
Path Parameters
id*string
The virtual machine's id, twelve lowercase hex characters.
Match
^[0-9a-f]{12}$Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/vms/string/force-stop"{ "id": "string", "state": "stopped"}Download a VM image POST
Fetch a template's image, or any https image by URL with its kind, into the library. The download runs in the background and `GET /api/vm-images` reports its progress. Requires the **admin** role.
Get a virtual machine GET
One VM in full: its summary, its stored configuration, its folder, whether a console can open, and whether each published port is listening. Requires the **viewer** role.