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}

Create image

cURL

curl --request POST \
  --url https://api.gcore.com/cloud/v1/bmimages/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-image",
  "volume_id": "d478ae29-dedc-4869-82f0-96104425f565",
  "architecture": "x86_64",
  "hw_firmware_type": "bios",
  "hw_machine_type": "q35",
  "is_baremetal": false,
  "os_type": "linux",
  "source": "volume",
  "ssh_key": "allow",
  "tags": {
    "my-tag": "my-tag-value"
  }
}
'

200

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

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

Example:

1

region_id · integer · required

Region ID

Example:

7

Body

application/json

name · string · required

Image name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

Example:

"my-image"

volume_id · string<uuid4> · required

Required if source is volume. Volume id

Example:

"d478ae29-dedc-4869-82f0-96104425f565"

architecture · enum<string> · default: x86_64

Image CPU architecture type: aarch64, x86_64

Available options: aarch64, x86_64

Example:

"x86_64"

hw_firmware_type · enum<string> | null

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

Available options: bios, uefi

Example:

"bios"

hw_machine_type · enum<string> | null

A virtual chipset type.

Available options: i440, q35

Example:

"q35"

is_baremetal · boolean · default: false

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

Example:

false

os_type · enum<string> · default: linux

The operating system installed on the image.

Available options: linux, windows

Example:

"linux"

source · string · default: volume

Image source

Allowed value: "volume"

Example:

"volume"

ssh_key · enum<string> · default: allow

Whether the image supports SSH key or not

Available options: allow, deny, required

Example:

"allow"

tags · CreateTagsSerializer · 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. Both tag keys and values have a maximum length of 255 characters. Tag keys and values cannot contain characters from U+0080 to U+00FF. 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.

Show child attributes

Example:

{ "my-tag": "my-tag-value" }

Response

200

application/json

OK

tasks · string[] · 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.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]