v32

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

Images

Create image

Create a new image from a bootable volume. The volume must be bootable to create an image from it.

post/cloud/v1/bmimages/{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'

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_type'linux' | 'windows'

source'volume'

Image source

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.

volume_idstring uuid4 required

Required if source is volume. Volume id

Example request

{
  "name": "my-image",
  "source": "volume",
  "volume_id": "d478ae29-dedc-4869-82f0-96104425f565"
}

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"
  ]
}