Sign in

v32

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

Update image

Update image properties and tags.

patch/cloud/v1/images/{project_id}/{region_id}/{image_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:7

Region ID

image_idstring required

Image ID

Example:8cab6f28-09ca-4201-b3f7-23c7893f4bd6

Image ID

Request body

hw_firmware_type'bios' | 'uefi'
hw_machine_type'i440' | 'q35'
is_baremetalboolean nullable

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

namestring

Image display name

os_type'linux' | 'windows'
ssh_key'allow' | 'deny' | 'required'
tagsUpdateTagsSerializer

Example request

{
  "name": "my-image"
}

Response

OK

architecture'aarch64' | 'x86_64' required
created_atstring date-time required

Datetime when the image was created

creator_task_idstring nullable required

Task that created this entity

currency_codestring nullable required

Currency code. Shown if the include_prices query parameter if set to true

descriptionstring nullable required

Image description

disk_formatstring required

Disk format

display_orderinteger nullable required
gpu_driverstring nullable required

Name of the GPU driver vendor

gpu_driver_typestring nullable required

Type of the GPU driver

gpu_driver_versionstring nullable required

Version of the installed GPU driver

hw_firmware_type'bios' | 'uefi' required
hw_machine_type'i440' | 'q35' required
idstring required

Image ID

is_baremetalboolean required

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

min_diskinteger required

Minimal boot volume required

min_raminteger required

Minimal VM RAM required

namestring required

Image display name

os_distrostring required

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

os_type'linux' | 'windows' required
os_versionstring required

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

price_status'error' | 'hide' | 'show' required
project_idinteger required

Project ID

regionstring required

Region name

region_idinteger required

Region ID

sizeinteger nullable required

Image size in bytes

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

Image status, i.e. active

task_idstring nullable required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

updated_atstring date-time required

Datetime when the image was updated

visibilitystring required

Image visibility. Globally visible images are public

Example response

{
  "created_at": "2024-05-05T14:51:26.570866Z",
  "creator_task_id": "b10dd116-07f5-4225-abb7-f42da5cb78fb",
  "currency_code": "USD",
  "description": "string",
  "disk_format": "raw",
  "display_order": 2010,
  "gpu_driver": "nvidia",
  "gpu_driver_type": "open",
  "gpu_driver_version": "570.148.08",
  "id": "44e136a7-15c1-4b5f-a086-20b7b3237d40",
  "min_disk": 3,
  "name": "ubuntu-20.10-x64",
  "os_distro": "ubuntu",
  "os_version": "20.10",
  "project_id": 1337,
  "region": "Luxembourg 1",
  "region_id": 7,
  "size": 2361393152,
  "status": "active",
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "updated_at": "2024-05-05T14:51:26.570866Z",
  "visibility": "public"
}