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

# List base images

> Lists ready base images, newest first. Use an image to create a boot disk and match optional
software by `os_release`.



## OpenAPI

````yaml openapi.yaml GET /v1/orchestrator/catalog/images
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/catalog/images:
    get:
      tags:
        - Disks
      summary: List base images
      description: >-
        Lists ready base images, newest first. Use an image to create a boot
        disk and match optional

        software by `os_release`.
      operationId: listVmBaseImages
      responses:
        '200':
          description: List base images.
          content:
            application/json:
              schema:
                type: object
                required:
                  - images
                properties:
                  images:
                    type: array
                    items:
                      $ref: '#/components/schemas/VmBaseImage'
              example:
                images:
                  - id: 55555555-5555-4555-8555-555555555555
                    display_name: Ubuntu 24.04
                    os_release: ubuntu-24.04
                    sha256: >-
                      bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
                    size_bytes: 536870912
                    created_at: '2026-10-19T15:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    VmBaseImage:
      type: object
      required:
        - id
        - display_name
        - os_release
        - sha256
        - size_bytes
        - created_at
      properties:
        id:
          type: string
          format: uuid
        display_name:
          type: string
        os_release:
          type:
            - string
            - 'null'
          description: >-
            OS release slug used to select compatible software, such as
            ubuntu-24.04.
        sha256:
          type: string
        size_bytes:
          type: integer
          format: int64
        created_at:
          type: string
          format: date-time
    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.