List images

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
image_list = client.cloud.instances.images.list(
    project_id=0,
    region_id=0,
)
print(image_list.count)

{
  "count": 1,
  "results": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "disk_format": "<string>",
      "id": "<string>",
      "min_disk": 123,
      "min_ram": 123,
      "name": "<string>",
      "os_distro": "<string>",
      "os_type": "linux",
      "os_version": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "size": 123,
      "status": "<string>",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "visibility": "<string>",
      "architecture": "x86_64",
      "creator_task_id": "b10dd116-07f5-4225-abb7-f42da5cb78fb",
      "description": "string",
      "display_order": 2010,
      "gpu_driver": "nvidia",
      "gpu_driver_type": "open",
      "gpu_driver_version": "570.148.08",
      "hw_firmware_type": "bios",
      "hw_machine_type": "q35",
      "is_baremetal": false,
      "ssh_key": "allow",
      "task_id": null
    }
  ]
}

GET

cloud

images

{project_id}

{region_id}

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
image_list = client.cloud.instances.images.list(
    project_id=0,
    region_id=0,
)
print(image_list.count)

{
  "count": 1,
  "results": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "disk_format": "<string>",
      "id": "<string>",
      "min_disk": 123,
      "min_ram": 123,
      "name": "<string>",
      "os_distro": "<string>",
      "os_type": "linux",
      "os_version": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "size": 123,
      "status": "<string>",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "visibility": "<string>",
      "architecture": "x86_64",
      "creator_task_id": "b10dd116-07f5-4225-abb7-f42da5cb78fb",
      "description": "string",
      "display_order": 2010,
      "gpu_driver": "nvidia",
      "gpu_driver_type": "open",
      "gpu_driver_version": "570.148.08",
      "hw_firmware_type": "bios",
      "hw_machine_type": "q35",
      "is_baremetal": false,
      "ssh_key": "allow",
      "task_id": null
    }
  ]
}

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

Query Parameters

include_prices

boolean

Show price

private

string

Any value to show private images

tag_key

string[]

Filter by tag keys.

tag_key_value

string

Filter by tag key-value pairs. Must be a valid JSON string.

visibility

enum<string>

Image visibility. Globally visible images are public

Available options:

private,

public,

shared

Response

200 - application/json

List of images

count

integer

required

Number of objects

Required range: x >= 0

results

Image schema · object[]

required

Objects

Show child attributes

results.created_at

string<date-time>

required

Datetime when the image was created

results.disk_format

string

required

Disk format

results.id

string

required

Image ID

results.min_disk

integer

required

Minimal boot volume required

results.min_ram

integer

required

Minimal VM RAM required

results.name

string

required

Image display name

results.os_distro

string

required

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

results.os_type

enum<string>

required

The operating system installed on the image.

Available options:

linux,

windows

results.os_version

string

required

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

results.project_id

integer

required

Project ID

results.region

string

required

Region name

results.region_id

integer

required

Region ID

results.size

integer

required

Image size in bytes

results.status

string

required

Image status, i.e. active

results.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.

Show child attributes

results.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

results.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

results.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

results.updated_at

string<date-time>

required

Datetime when the image was updated

results.visibility

string

required

Image visibility. Globally visible images are public

results.architecture

enum<string>

default:x86_64

An image architecture type: aarch64, x86_64

Available options:

aarch64,

x86_64

results.creator_task_id

string | null

Task that created this entity

Example:

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

results.description

string | null

Image description

Example:

"string"

results.display_order

integer | null

Example:

2010

results.gpu_driver

string | null

Name of the GPU driver vendor

Example:

"nvidia"

results.gpu_driver_type

string | null

Type of the GPU driver

Example:

"open"

results.gpu_driver_version

string | null

Version of the installed GPU driver

Example:

"570.148.08"

results.hw_firmware_type

enum<string> | null

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

Available options:

bios,

uefi

Example:

"bios"

results.hw_machine_type

enum<string> | null

A virtual chipset type.

Available options:

pc,

q35

Example:

"q35"

results.is_baremetal

boolean | null

default:false

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

Example:

false

results.ssh_key

enum<string> | null

Whether the image supports SSH key or not

Available options:

allow,

deny,

required

Example:

"allow"

results.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.

Example:

null

Upload image Create image

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Query Parameters

Response