Udon is under active development. Documentation not final.
udonudon
Virtual machines

Edit a virtual machine

Change the fields sent and leave the rest. Name, description, autostart and forwards apply at any time; CPUs, memory, display and media need the VM stopped. Requires the **admin** role.

PUT
/api/vms/{id}

Authorization

udon_session<token>

In: cookie

Path Parameters

id*string

The virtual machine's id, twelve lowercase hex characters.

Match^[0-9a-f]{12}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Only the fields sent change. forwards replaces the whole list.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/api/vms/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "description": "string",  "backend": "apple",  "guest": {    "kind": "linux",    "template": "string",    "icon": "string"  },  "cpus": 0,  "memoryBytes": 0,  "state": "stopped",  "ip": "string",  "startedAt": "2019-08-24T14:15:22Z",  "error": "string",  "autostart": true,  "forwards": [    {      "proto": "tcp",      "hostPort": 0,      "guestPort": 0    }  ],  "usage": {    "cpu": 0,    "memoryBytes": 0  },  "diskBytes": 0,  "diskUsedBytes": 0,  "windowVisible": true,  "createdAt": "2019-08-24T14:15:22Z"}

Ask AI

Answers from Udon's documentation.

Ask how to install Udon, run containers, or share folders.