Skip to main content
GET
/
api
/
v2
/
regions
/
{regionID}
/
images
List compute disk images
curl --request GET \
  --url https://api.example.com/api/v2/regions/{regionID}/images \
  --header 'Authorization: Bearer <token>'
[
  {
    "metadata": {
      "id": "a64f9269-36e0-4312-b8d1-52d93d569b7b",
      "name": "ubu2204-v1.25.6-gpu-525.85.05-7ced4154",
      "creationTime": "2023-02-22T12:04:13Z"
    },
    "spec": {
      "architecture": "x86_64",
      "sizeGiB": 10,
      "virtualization": "virtualized",
      "os": {
        "kernel": "linux",
        "family": "debian",
        "distro": "ubuntu",
        "variant": "server",
        "codename": "noble",
        "version": "24.04"
      },
      "softwareVersions": {
        "kubernetes": "v1.25.6"
      },
      "gpu": {
        "vendor": "NVIDIA",
        "driver": "525.85.05",
        "models": [
          "A100",
          "H100",
          "H200"
        ]
      }
    },
    "status": {
      "state": "ready"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

​
regionID
string<uuid>
required

The region ID. A region ID.

Query Parameters

​
organizationID
string[]

Allows resources to be filtered by organization.

​
scope
enum<string>

Filter for images owned by the organization specified, or available (either globally or to the organization given).

Available options:
owned,
available
​
status
enum<string>[]

Filter for images by status

The images's lifecycle state.

Available options:
pending,
creating,
ready,
failed

Response

A list of images that are compatible with this platform.

​
metadata
object
required

This metadata is for resources that just exist, and don't require any provisioning and health status, but benefit from a standardized metadata format.

​
spec
object
required

An image.

​
status
object
required

The image's status.