Skip to main content
GET
/
cloud
/
v1
/
bmimages
/
{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.baremetal.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,
      "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. 'curl -G --data-urlencode 'tag_key_value={"key": "value"}' --url 'http://localhost:1111/v1/images/1/1'"

​
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
Example:

1

​
results
Image schema · object[]
required

Objects