Skip to main content
POST
Create a disk
Choose a base image and any compatible software. Save the disk’s id to use it on a reservation.

Authorizations

Authorization
string
header
required

Send an organization API key as a bearer token.

Body

application/json
display_name
string
required

Nonblank display name; surrounding whitespace is trimmed.

Minimum string length: 1
image_id
string<uuid>
required

A ready base image from List base images.

cuda_version
string | null

Optional choice from List disk software, supported by the base image os_release.

nvidia_driver_version
string | null

Optional choice from List disk software, supported by the base image os_release.

dcgmi_version
string | null

Optional choice from List disk software, supported by the base image os_release.

python_version
string | null

Optional choice from List disk software, supported by the base image os_release.

python_packages
string[]

Optional package slugs from the software catalog. Without python_version, packages use the image system Python.

Response

Create a disk.

A reusable VM boot disk. VM writes go to its own local copy. A nonempty sha256 means this boot disk has bytes ready; a created disk can also be selected before its first build.

id
string<uuid>
required
organization_id
string<uuid> | null
required

Your organization ID, or null for an Ornn disk shared with organizations.

display_name
string
required
sha256
string
required

SHA-256 of the qcow2 bytes. Empty until an upload completes or a created disk is built.

size_bytes
integer<int64>
required

Stored qcow2 file size in bytes, not the VM filesystem capacity. Zero before bytes are ready.

image_id
string<uuid> | null
required

Base image for a created disk; null for uploaded or imported disks.

build_status
string | null
required

Created disks report unbuilt, building, ready, or failed. Uploaded and imported disks report null, even when ready. Handle unrecognized values.

build_error
string | null
required

Customer-facing build failure message, when available.

built_at
string<date-time> | null
required

Time a created disk last finished building. Ornn rebuilds created disks daily, which also changes sha256. Null for uploaded or imported disks.

cuda_version
string | null
required

A software catalog slug. Null means no version selected.

nvidia_driver_version
string | null
required

A software catalog slug. Null means no version selected.

dcgmi_version
string | null
required

A software catalog slug. Null means no version selected.

python_version
string | null
required

A software catalog slug. Null means no version selected.

python_packages
string[]
required

Python package slugs. Software metadata is not inferred from uploaded bytes.

created_at
string<date-time>
required