Kvindo™ Cloud Docs


Language

Image

An Image is a captured copy of a VM's disks — or of a single Volume — stored in the platform. Use it to back up a VM or volume and to restore or clone from that captured state. (Base OS images — such as Ubuntu Server 24.04 — are referenced separately by an osImageId string on a Volume, not by an Image resource.)

Key concepts

Source — either the VM whose disks are captured (spec.vmId) or a single Volume (spec.volumeId); exactly one of the two must be set

Captured volumes — the volumes contained in this image, one record per source-VM disk (device index, size, offer, OS image)

Restore — create a VM from an image by setting the VM's imageId to this image; a Volume can likewise be restored via its imageId (only from an image captured from a Volume)

Automation — capture images on a recurring schedule with an Image Schedule

Parameters
UI Name API / kc name Terraform name Optional Format Default Is read only Description
Source VM spec.vmId spec.vm_id Yes ULID (nullable) — references a VM No The VM whose disks are captured into this image. Exactly one of vmId/volumeId must be set
Source Volume spec.volumeId spec.volume_id Yes ULID (nullable) — references a Volume No A single Volume to capture into this image. Exactly one of vmId/volumeId must be set
Size (bytes) status.sizeBytes status.size_bytes integer Yes Total image size in bytes
Volumes status.volumes status.volumes array of objects Yes Per-volume details of the volumes contained in this image (device index, size, offer, OS image). Flattened to a string in Terraform
Examples

Terraform

Python SDK

kc CLI


Related pages

Resource docs

Examples

More in this section

An unhandled error has occurred. Reload 🗙