Create a VM
Creates a virtual machine in the project, then starts it. The request waits until creation finishes. Requires a project role that can write VMs. Card verification, a prepaid hold, or a suspended account blocks creation. CPU, RAM, and disk must follow the account grid and quotas. At least one network is required (public WAN and/or a private network). os_image is the image filename from the cluster image store. SSH keys must belong to the API key owner (Settings → SSH Keys), at most five. The response is the assigned VMID. You can lower CPU, RAM, or CPU class 24 hours after create.
Authorization
bearerAuth API key created in the portal (Settings → API Keys). Send as Authorization: Bearer <key>.
In: header
Path Parameters
Project UUID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Fields required to create a virtual machine.
Response Body
application/json
curl -X POST "https://example.com/cloud/project/string/vm/" \ -H "Content-Type: application/json" \ -d '{ "hostname": "string", "password": "string", "cores": 2, "ram_gb": 1, "os_disk_gb": 10, "os_image": "string" }'{ "vmid": 0}