Image API

Image API

Import disk artifacts, inspect regional availability, and manage image revisions.

The Image API creates regional boot artifacts and tracks their immutable content revisions. A ready image can be referenced by droplet creation and templates.

Import

POST/organizations/{organization_id}/projects/{project_id}/images
Scope
images:write
Auth
Bearer API key
Repeat calls
Use one Idempotency-Key for the intended artifact import.

Imports a disk artifact into the permitted project and region.

Artifact import
namestringrequired
Mutable display name.
region_idstringrequired
Permitted destination region.
sourceobjectrequired
Contains an approved HTTPS url and required sha256 content checksum.
formatstringrequired
Disk format after supported decompression.
one ofraw, qcow2
architecturestringrequired
Must match the destination's supported compute architecture.
one ofx86_64, aarch64
firmwarestringrequired
Boot firmware required by this artifact.
one ofuefi, bios
minimum_root_gibintegerrequired
Must fit the expanded disk contents.
ruleAt least 1

Returns 202 with the image ID and import operation. Import workers use the approved artifact path; they do not receive arbitrary guest network access. Checksum mismatch ends the operation with checksum_mismatch and leaves the image unavailable for boot.

Read availability

GET/organizations/{organization_id}/projects/{project_id}/images/{image_id}
Scope
images:read
Auth
Bearer API key

Returns ID, revision, checksum, format, architecture, firmware, minimum root size, initialization capabilities, and state. Requires images:read. States are importing, ready, deprecated, deleting, and error.

GET/organizations/{organization_id}/projects/{project_id}/images
Scope
images:read
Auth
Bearer API key

Lists regional images using the selected filters.

List filters include region_id, architecture, state, and label. A ready image in another region is not a valid local image_id reference.

Copy

POST/organizations/{organization_id}/projects/{project_id}/images/{image_id}/copies
Scope
images:write
Auth
Bearer API key

Copies an image into a permitted destination region.

Accepts required destination_region_id and optional destination name. It requires images:write and returns 202 with a new regional image ID and transfer operation.

Policy and encryption access are checked at the destination. A copy is usable only after its own operation and validation succeed. Deleting the source during an active copy returns 409 image_copy_in_progress.

Deprecate and delete

PATCH/organizations/{organization_id}/projects/{project_id}/images/{image_id}
Scope
images:write
Auth
Bearer API key

Updates image metadata or deprecation state.

Requires If-Match. Updates name, labels, and deprecated. Deprecation hides the image from ordinary defaults while allowing permitted explicit references. It does not alter running guests or their disks.

DELETE/organizations/{organization_id}/projects/{project_id}/images/{image_id}
Scope
images:write
Auth
Bearer API key

Deletes an image after retained references and active work permit removal.

Requires the current ETag. Active imports, copies, or retained template references can block removal. Accepted cleanup returns 202; it does not delete volumes previously created from the image.

Use Images and templates for guest preparation and Template API for pinned configuration revisions.