> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ornn.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a disk

> Creates a reusable boot disk from a base image and optional software. Match the software to the
image's `os_release`. The first VM launch builds the disk, and a later launch retries a failed
build.

Use a read-write key from an approved organization. If the request times out, look for the disk
before retrying.

Choose a [base image](https://docs.ornn.com/api-reference/disks/list-images.md) and any [compatible software](https://docs.ornn.com/api-reference/disks/list-software.md). Save the disk's `id` to [use it on a reservation](https://docs.ornn.com/api-reference/virtual-machines/set-image.md).


## OpenAPI

````yaml openapi.yaml POST /v1/orchestrator/disks
openapi: 3.1.0
info:
  title: Ornn compute API
  version: 1.0.0
  description: >-
    The Ornn REST API manages compute capacity, machines, clusters, storage,
    networking, and billing.

    Each organization API key has read-only or read-write access in one
    organization. Approved

    organizations can browse Reserve and buy fixed windows.


    See the [API overview](https://docs.ornn.com/api-reference/overview) for
    your first request and [API

    keys](https://docs.ornn.com/api-keys) to create a key. Examples use
    fictional IDs and credentials.

    `info.version` identifies the contract revision.
  contact:
    email: support@ornn.com
servers:
  - url: https://api.ornn.com
    description: Production
security:
  - OrnnApiKey: []
tags:
  - name: Authentication
  - name: Reservations
  - name: Nodes
  - name: Clusters
  - name: Workers
  - name: Virtual machines
    description: >-
      Choose a VM disk, launch VM access on a reservation, and read each VM's
      status, launch progress, and SSH connection details.
  - name: Disks
    description: >-
      Discover VM boot disks, create one from a base image and software, upload
      or import qcow2 bytes, and delete unused disks.
  - name: Bare Metal
    description: >-
      Launch Bare Metal access on a reservation, read a host's readiness and SSH
      connection details, and reboot or hard reset it.
  - name: SSH keys
    description: >-
      Register public keys for your organization, choose which keys a VM or Bare
      Metal reservation uses, and queue key delivery to machines. Slurm clusters
      use the saved reservation selections, which can be set at launch.
      Kubernetes API access does not use SSH keys.
  - name: Reserve
    description: >-
      Browse reserved-capacity listings and their terms, and post, cancel, or
      accept offers. Reserve listings are visible to approved organizations.
  - name: Market
    description: >-
      Browse relisted capacity and buy windows at the asking price. Payment
      follows the separately arranged or upfront checkout flow described in Buy
      Market windows. Open to every member of your organization.
  - name: Order books
    description: >-
      Hourly order books for whole nodes, one VM per node: read books, trades,
      and quotes, place and cancel bids, and follow and end fills.
  - name: Relist
    description: >-
      Sell whole nodes from a reservation you hold at your asking price, and
      manage those listings.
  - name: Storage
    description: >-
      Managed volumes, their files, and GitHub repository pulls. Volumes belong
      to the API key's organization; every member can use every volume in it.
  - name: Networks
    description: >-
      Organization private networks and the WireGuard configs you use to reach
      private machines and clusters.
  - name: Monitoring
    description: >-
      Machine telemetry and console logs for capacity your organization holds.
      Reads are limited to your reservation window.
  - name: Billing
    description: >-
      Invoices, billing summary, usage cost, Ornn credits, and account
      statements. Saving a card and paying invoices stay in the console.
externalDocs:
  description: REST integration walkthrough
  url: https://docs.ornn.com/guides/kubernetes-api
paths:
  /v1/orchestrator/disks:
    post:
      tags:
        - Disks
      summary: Create a disk
      description: >-
        Creates a reusable boot disk from a base image and optional software.
        Match the software to the

        image's `os_release`. The first VM launch builds the disk, and a later
        launch retries a failed

        build.


        Use a read-write key from an approved organization. If the request times
        out, look for the disk

        before retrying.
      operationId: createVmDisk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VmDiskCreate'
            example:
              display_name: Training disk
              image_id: 55555555-5555-4555-8555-555555555555
              python_version: '3.12'
              python_packages:
                - torch
      responses:
        '201':
          description: Create a disk.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VmDisk'
              example:
                id: 44444444-4444-4444-8444-444444444444
                organization_id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
                display_name: Training disk
                sha256: ''
                size_bytes: 0
                image_id: 55555555-5555-4555-8555-555555555555
                build_status: unbuilt
                build_error: null
                built_at: null
                cuda_version: null
                nvidia_driver_version: null
                dcgmi_version: null
                python_version: '3.12'
                python_packages:
                  - torch
                created_at: '2026-10-20T15:00:00Z'
        '400':
          description: >-
            Missing display name or image ID, unknown_catalog_term, or
            disk_stack_unsupported for software incompatible with the base
            image.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: 'image_not_found: the image is absent or not ready.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    VmDiskCreate:
      type: object
      required:
        - display_name
        - image_id
      properties:
        display_name:
          type: string
          description: Nonblank display name; surrounding whitespace is trimmed.
          minLength: 1
        image_id:
          type: string
          description: A ready base image from List base images.
          format: uuid
        cuda_version:
          type:
            - string
            - 'null'
          description: >-
            Optional choice from List disk software, supported by the base image
            os_release.
        nvidia_driver_version:
          type:
            - string
            - 'null'
          description: >-
            Optional choice from List disk software, supported by the base image
            os_release.
        dcgmi_version:
          type:
            - string
            - 'null'
          description: >-
            Optional choice from List disk software, supported by the base image
            os_release.
        python_version:
          type:
            - string
            - 'null'
          description: >-
            Optional choice from List disk software, supported by the base image
            os_release.
        python_packages:
          type: array
          items:
            type: string
          description: >-
            Optional package slugs from the software catalog. Without
            python_version, packages use the image system Python.
    VmDisk:
      type: object
      required:
        - id
        - organization_id
        - display_name
        - sha256
        - size_bytes
        - image_id
        - build_status
        - build_error
        - built_at
        - cuda_version
        - nvidia_driver_version
        - dcgmi_version
        - python_version
        - python_packages
        - created_at
      properties:
        id:
          type: string
          format: uuid
        organization_id:
          type:
            - string
            - 'null'
          description: >-
            Your organization ID, or null for an Ornn disk shared with
            organizations.
          format: uuid
        display_name:
          type: string
        sha256:
          type: string
          description: >-
            SHA-256 of the qcow2 bytes. Empty until an upload completes or a
            created disk is built.
        size_bytes:
          type: integer
          format: int64
          description: >-
            Stored qcow2 file size in bytes, not the VM filesystem capacity.
            Zero before bytes are ready.
        image_id:
          type:
            - string
            - 'null'
          description: Base image for a created disk; null for uploaded or imported disks.
          format: uuid
        build_status:
          type:
            - string
            - 'null'
          description: >-
            Created disks report unbuilt, building, ready, or failed. Uploaded
            and imported disks report null, even when ready. Handle unrecognized
            values.
        build_error:
          type:
            - string
            - 'null'
          description: Customer-facing build failure message, when available.
        built_at:
          type:
            - string
            - 'null'
          description: >-
            Time a created disk last finished building. Ornn rebuilds created
            disks daily, which also changes sha256. Null for uploaded or
            imported disks.
          format: date-time
        cuda_version:
          type:
            - string
            - 'null'
          description: A software catalog slug. Null means no version selected.
        nvidia_driver_version:
          type:
            - string
            - 'null'
          description: A software catalog slug. Null means no version selected.
        dcgmi_version:
          type:
            - string
            - 'null'
          description: A software catalog slug. Null means no version selected.
        python_version:
          type:
            - string
            - 'null'
          description: A software catalog slug. Null means no version selected.
        python_packages:
          type: array
          items:
            type: string
          description: >-
            Python package slugs. Software metadata is not inferred from
            uploaded bytes.
        created_at:
          type: string
          format: date-time
      description: >-
        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.
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
  responses:
    Unauthorized:
      description: >-
        The credential is missing, invalid, or revoked. Check the HTTP status
        before parsing the body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The credential lacks access to this operation, or the Reserve operation
        requires approval. An API key does not bypass these checks.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: >-
        Check the HTTP status first. If the response is JSON, read its error
        code and message. See

        [Errors](/api-reference/overview#errors) for response formats and retry
        guidance.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    OrnnApiKey:
      type: http
      scheme: bearer
      bearerFormat: ornn_sk_...
      description: Send an [organization API key](/api-keys) as a bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.