Skip to main content
POST
/
api
/
v1
/
organizations
/
{organizationID}
/
regions
/
{regionID}
/
images
Create a compute image from a disk image URL.
curl --request POST \
  --url https://region.nks.europe-west4.nscale.com/api/v1/organizations/{organizationID}/regions/{regionID}/images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "ubu2204-v1.25.6-gpu-525.85.05-7ced4154"
  },
  "spec": {
    "uri": "https://example.com/buckets/myimages/ubu2204-v1.25.6-gpu-525.85.05-7ced4154.raw",
    "architecture": "x86_64",
    "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"
      ]
    }
  }
}
'
{
  "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

​
organizationID
string
required

An organization ID.

​
regionID
string
required

The region ID. A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length.

Required string length: 1 - 63

Body

application/json

A request to create an image.

A compute image create request.

​
metadata
object
required

Metadata required for all API resource reads and writes.

​
spec
object
required

A compute image specification.

Response

An image that can be used on this platform.

An image.

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