Create a machine
create_vmOrders a machine and spends credit (hourly) or raises an invoice (monthly). Returns the machine and a provisioning action to poll with get_action. Retrying the same order is safe: it is deduplicated for 24 hours. Scope: vms.create.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vpc | No | Private network id (list_vpcs) to connect the machine to, in the same region. | |
| ipv4 | No | false orders an IPv6-only machine, cheaper; outbound IPv4 goes through NAT64. | |
| plan | Yes | Plan slug from list_plans, e.g. nano. | |
| image | Yes | Image slug from list_images, e.g. debian-13. | |
| region | Yes | Region slug from list_regions, e.g. montreal. | |
| billing | Yes | Hourly draws on prepaid credit; monthly raises an invoice. Fixed for the life of the machine. | |
| options | No | Paid options declared by the plan, by name. | |
| payment | No | Monthly only. credit pays from the balance when it covers the invoice. | |
| hostname | Yes | Letters, digits, dots and hyphens; no leading, trailing or doubled separator. | |
| ssh_keys | No | Fingerprints or ids of SSH keys already on the account (see list_ssh_keys). | |
| private_only | No | No public address at all; needs vpc. Reachable only from the private network, Internet through its gateway. Priced like ipv4: false. | |
| idempotency_key | No | Your own unique value per order. By default one is derived from the order itself. | |
| password_delivery | No | email mails a generated password; none needs at least one SSH key. |