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

# Get a reservation

> Returns one reservation visible to your organization. A reservation is not a cluster; launching a cluster is a separate operation.

Reservations created on renewable terms have `endsAt: null` and retain the agreed
period in `durationHours`. Non-renewable reservations keep their agreed end date.


## OpenAPI

````yaml openapi.yaml GET /commerce/reservations/{reservationId}
openapi: 3.1.0
info:
  title: Ornn compute API
  version: 1.0.0
  description: >-
    Customer HTTP API for Ornn GPU capacity. It covers reserved capacity and
    nodes, VM and Bare Metal access, Kubernetes and Slurm clusters, SSH keys,
    storage volumes and GitHub repositories, private networks, monitoring,
    buying and selling capacity (Reserve, Market, Spot, and Relist), and
    billing. API keys are scoped to one organization and act with their
    creator's access there; account, team, and API-key management stay in the
    console. Most operations require an approved organization. See
    https://docs.ornn.com/api-keys to create a key and
    https://docs.ornn.com/guides/kubernetes-api for an end-to-end Kubernetes
    integration. Examples use fictional IDs and credentials. The info.version
    field identifies the contract revision, not a shared API path version.
  contact:
    email: support@ornn.com
servers:
  - url: https://api.ornn.com
    description: Production
security:
  - OrnnApiKey: []
tags:
  - name: Authentication
  - name: Reservations
  - name: GPU 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: 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
      take organization key IDs 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, paid up
      front. Open to every member of your organization.
  - name: Spot
    description: >-
      Hourly order books for VMs with 1, 2, 4, or 8 GPUs on one node: read
      books, trades, and quotes, place and cancel bids, and follow 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 creator in the key's organization.
  - 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-access#provision-and-manage-through-rest
paths:
  /commerce/reservations/{reservationId}:
    get:
      tags:
        - Reservations
      summary: Get a reservation
      description: >-
        Returns one reservation visible to your organization. A reservation is
        not a cluster; launching a cluster is a separate operation.
      operationId: getReservation
      parameters:
        - name: reservationId
          in: path
          required: true
          description: Reservation ID.
          schema:
            type: string
            format: uuid
          example: 11111111-1111-4111-8111-111111111111
      responses:
        '200':
          description: >-
            The visible reservation. Additional reservation fields are described
            below.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reservation'
              example:
                reservationId: 11111111-1111-4111-8111-111111111111
                customerId: 22222222-2222-4222-8222-222222222222
                status: active
                isSpot: false
                provisioningType: kubernetes
                gpuSlug: h100
                gpusPerNode: 8
                reservedNodeCount: 1
                reservedGpuCount: 8
                startsAt: '2026-10-14T00:00:00Z'
                endsAt: '2026-10-21T00:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    Reservation:
      type: object
      required:
        - reservationId
        - status
        - isSpot
        - reservedNodeCount
        - reservedGpuCount
        - startsAt
        - endsAt
      properties:
        reservationId:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        listingId:
          type: string
          format: uuid
        listingTermId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - confirmed
            - active
            - completed
            - cancelled
        isSpot:
          type: boolean
        provisioningType:
          type: string
          enum:
            - virtual-machine
            - bare-metal
            - kubernetes
            - slurm
        facilityId:
          type: string
          format: uuid
        gpuSlug:
          type: string
        gpusPerNode:
          type: integer
        reservedNodeCount:
          type: integer
        reservedGpuCount:
          type: integer
        startsAt:
          type: string
          format: date-time
        endsAt:
          type:
            - string
            - 'null'
          format: date-time
        pricePerGpuHourMicroUsd:
          type: integer
          format: int64
          description: >-
            Your agreed reservation rate in integer micro-USD per GPU-hour,
            including any fee you pay. Historical reservations without a saved
            rate show the linked listing term price.
        durationHours:
          type:
            - number
            - 'null'
          description: >-
            Original agreed duration in hours, separate from operational start
            and end dates. Renewable reservations retain this duration with a
            null end date. Null when no duration was agreed.
        renewable:
          type:
            - boolean
            - 'null'
          description: Whether the reservation contract permits renewal.
        downPaymentCents:
          type:
            - integer
            - 'null'
          format: int64
        pendingOperation:
          type:
            - string
            - 'null'
        pendingOperationId:
          type: string
          format: uuid
        vmDiskId:
          type:
            - string
            - 'null'
          format: uuid
        deployedAt:
          type:
            - string
            - 'null'
          format: date-time
        endReason:
          type:
            - string
            - 'null'
        transactionId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        relistableNodeCount:
          type: integer
        relistUnavailableReason:
          type:
            - string
            - 'null'
        relistableNodeIds:
          type: array
          items:
            type: string
            format: uuid
    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, revoked, or no longer belongs to a
        current organization member. 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 organization
        requires approval. An API key does not bypass these checks.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: >-
        Unsuccessful request. Check HTTP status first. Errors may have
        detail.code/detail.message, a string detail and optional top-level code,
        or an empty/non-JSON body. 401: invalid credential; 403: access or
        approval required; 404: not visible or credentials not ready; 409:
        lifecycle conflict; 429: back off; 5xx: service failure. Inspect current
        state before retrying mutations.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    OrnnApiKey:
      type: http
      scheme: bearer
      bearerFormat: ornn_sk_...
      description: >-
        Create an organization API key in Account Settings > Developer. Do not
        send this key to the Kubernetes API server.

````

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