Regions, plans, and images

A machine is created from three catalog entries: a plan (size, price, and backend), an image (what the disk starts from), and a region (where it runs). Each entry has an id and a version, and a create request names both, so a later change to the catalog never changes an existing machine or a request you already sent.

Reading the catalog

vy plans
vy images
vy regions

Any member and any API key preset can read the catalog. The exact sizes, images, and regions on offer come from your VMYard deployment; always read them from the catalog rather than hard-coding them.

Plans

A plan has a name, version, cpu, memory_mib, disk_gib, backend, and a price with hourly and monthly USD amounts. Machines are billed per second at the plan's hourly price while they run.

Sizes are priced like this:

The multiplier is a size's hourly price relative to default. Plan allowances and the trial are counted in default-size hours, so one hour of small uses half an hour of allowance. Trials can use only small and default. See Usage, billing, and limits.

Images

An image has a name, a version, and a content digest. A machine's disk starts from the exact image version you choose.

Regions

A region has a name, a version, a backend, and a capacity_status. Choose a region whose backend matches the plan's backend.

Choosing entries

The SDKs and CLI accept names or IDs and resolve them to the latest version for you. They default to the first plan, the first image, and the first region that matches the plan's backend.

vy new --plan small --image ubuntu-24.04 --region eu-central --name dev

The image and region names above are examples; use the names your catalog lists. With the HTTP API, send plan, image, and region as {id, version}, plus the plan's resources and backend. See Create a machine.