PATCH
/
cloud
/
v1
/
images
/
{project_id}
/
{region_id}
/
{image_id}
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
image = client.cloud.instances.images.update(
    image_id="image_id",
    project_id=0,
    region_id=0,
)
print(image.id)
{
  "architecture": "x86_64",
  "created_at": "2024-05-05T14:51:26.570866Z",
  "creator_task_id": "b10dd116-07f5-4225-abb7-f42da5cb78fb",
  "description": "string",
  "disk_format": "raw",
  "display_order": 2010,
  "hw_firmware_type": "bios",
  "hw_machine_type": "q35",
  "id": "44e136a7-15c1-4b5f-a086-20b7b3237d40",
  "is_baremetal": false,
  "min_disk": 3,
  "min_ram": 0,
  "name": "ubuntu-20.10-x64",
  "os_distro": "ubuntu",
  "os_type": "linux",
  "os_version": "20.10",
  "project_id": 1337,
  "region": "Luxembourg 1",
  "region_id": 7,
  "size": 2361393152,
  "ssh_key": "allow",
  "status": "active",
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "task_id": null,
  "updated_at": "2024-05-05T14:51:26.570866Z",
  "visibility": "public"
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

region_id
integer
required

Region ID

image_id
string
required

Image ID

Body

application/json
hw_firmware_type
enum<string>

Specifies the type of firmware with which to boot the guest.

Available options:
bios,
uefi
hw_machine_type
enum<string>

A virtual chipset type.

Available options:
pc,
q35
is_baremetal
boolean

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

Examples:

false

name
string

Image display name

Examples:

"my-image"

os_type
enum<string>

The operating system installed on the image.

Available options:
linux,
windows
ssh_key
enum<string>

Whether the image supports SSH key or not

Available options:
allow,
deny,
required
tags
object

Key-value tags to associate with the resource. 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.

Response

Returned image

created_at
string<date-time>
required

Datetime when the image was created

Examples:

"2024-05-05T14:51:26.570866Z"

disk_format
string
required

Disk format

Examples:

"raw"

id
string
required

Image ID

Examples:

"44e136a7-15c1-4b5f-a086-20b7b3237d40"

min_disk
integer
required

Minimal boot volume required

Examples:

3

min_ram
integer
required

Minimal VM RAM required

Examples:

0

name
string
required

Image display name

Examples:

"ubuntu-20.10-x64"

os_distro
string
required

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

Examples:

"ubuntu"

os_type
enum<string>
required

The operating system installed on the image.

Available options:
linux,
windows
os_version
string
required

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

Examples:

"20.10"

project_id
integer
required

Project ID

Examples:

1337

region
string
required

Region name

Examples:

"Luxembourg 1"

region_id
integer
required

Region ID

Examples:

7

size
integer
required

Image size in bytes

Examples:

2361393152

status
string
required

Image status, i.e. active

Examples:

"active"

tags
TagSerializer · object[]
required

List of key-value tags associated with the resource. 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.

Examples:
[
{
"key": "my-tag",
"read_only": false,
"value": "my-tag-value"
}
]
updated_at
string<date-time>
required

Datetime when the image was updated

Examples:

"2024-05-05T14:51:26.570866Z"

visibility
string
required

Image visibility. Globally visible images are public

Examples:

"public"

architecture
enum<string>

An image architecture type: aarch64, x86_64

Available options:
aarch64,
x86_64
creator_task_id
string | null

Task that created this entity

Examples:

"b10dd116-07f5-4225-abb7-f42da5cb78fb"

description
string | null

Image description

Examples:

"string"

display_order
integer | null
Examples:

2010

hw_firmware_type
enum<string> | null

Specifies the type of firmware with which to boot the guest.

Available options:
bios,
uefi
Examples:

"bios"

hw_machine_type
enum<string> | null

A virtual chipset type.

Available options:
pc,
q35
Examples:

"q35"

is_baremetal
boolean | null
default:false

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

Examples:

false

ssh_key
enum<string> | null

Whether the image supports SSH key or not

Available options:
allow,
deny,
required
Examples:

"allow"

task_id
string | null

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.

Examples:

null