v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Images

Upload image

Upload an image from a URL. The image can be configured with various properties like OS type, architecture, and tags.

post/cloud/v1/downloadimage/{project_id}/{region_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:7

Region ID

Request body

architecture'aarch64' | 'x86_64'

cow_formatboolean

When True, image cannot be deleted unless all volumes, created from it, are deleted.

hw_firmware_type'bios' | 'uefi'

hw_machine_type'i440' | 'q35'

is_baremetalboolean

Set to true if the image will be used by bare metal servers. Defaults to false.

namestring required

Image name

os_distrostring nullable

OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.

os_type'linux' | 'windows'

os_versionstring nullable

OS version, i.e. 22.04 (for Ubuntu) or 9.4 for Debian

ssh_key'allow' | 'deny' | 'required'

tagsCreateTagsSerializer

A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

urlstring uri required

URL

Example request

{
  "name": "my-image",
  "os_distro": "ubuntu",
  "os_version": "22.04",
  "url": "http://mirror.noris.net/cirros/0.4.0/cirros-0.4.0-x86_64-disk.img"
}

Response

tasksstring[] required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

idstring required

Example response

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}