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
/organizations/{organization_id}/projects/{project_id}/imagesImports a disk artifact into the permitted project and region.
namestringrequiredregion_idstringrequiredsourceobjectrequiredurl and required sha256 content checksum.formatstringrequiredarchitecturestringrequiredfirmwarestringrequiredminimum_root_gibintegerrequiredReturns 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
/organizations/{organization_id}/projects/{project_id}/images/{image_id}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.
/organizations/{organization_id}/projects/{project_id}/imagesLists 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
/organizations/{organization_id}/projects/{project_id}/images/{image_id}/copiesCopies 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
/organizations/{organization_id}/projects/{project_id}/images/{image_id}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.
/organizations/{organization_id}/projects/{project_id}/images/{image_id}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.