> ## 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 reserved GPU nodes

> Returns up to 5,000 nodes belonging to an owned reservation. The customer response has no cursor; limit and cursor do not paginate this reservation-scoped read. A listed node is not necessarily ready to join a cluster. Check health_readiness for heartbeat-based launch blockers; ready true with heartbeat:unknown is not proof of a reachable host. Launch rechecks eligibility, ownership, and availability. This reference describes the buyer reservation view.



## OpenAPI

````yaml openapi.yaml GET /v1/orchestrator/nodes
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:
  /v1/orchestrator/nodes:
    get:
      tags:
        - GPU nodes
      summary: List reserved GPU nodes
      description: >-
        Returns up to 5,000 nodes belonging to an owned reservation. The
        customer response has no cursor; limit and cursor do not paginate this
        reservation-scoped read. A listed node is not necessarily ready to join
        a cluster. Check health_readiness for heartbeat-based launch blockers;
        ready true with heartbeat:unknown is not proof of a reachable host.
        Launch rechecks eligibility, ownership, and availability. This reference
        describes the buyer reservation view.
      operationId: listReservationNodes
      parameters:
        - name: reservation_id
          in: query
          required: true
          description: Owned reservation to inspect.
          schema:
            type: string
            format: uuid
          example: 11111111-1111-4111-8111-111111111111
      responses:
        '200':
          description: >-
            Nodes associated with the owned reservation; launch eligibility is
            checked separately.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeList'
              example:
                nodes:
                  - node_id: 33333333-3333-4333-8333-333333333333
                    reservation_id: 11111111-1111-4111-8111-111111111111
                    controller_id: null
                    status: bare-metal
                    health_readiness:
                      ready: true
                      status: ready
                      reasons: []
                      advisory_reasons: []
                    gpu_type: H100
                    gpu_count: 8
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    NodeList:
      type: object
      required:
        - nodes
      properties:
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Node'
    Node:
      type: object
      required:
        - node_id
        - reservation_id
        - controller_id
        - status
      properties:
        node_id:
          type: string
          format: uuid
        reservation_id:
          type:
            - string
            - 'null'
          format: uuid
        controller_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The cluster currently holding this node, or null.
        status:
          type: string
          description: >-
            Node lifecycle or access mode, such as bare-metal; not a liveness
            signal.
        health_readiness:
          $ref: '#/components/schemas/NodeHealthReadiness'
        gpu_type:
          type:
            - string
            - 'null'
        gpu_count:
          type:
            - integer
            - 'null'
        hostname:
          type:
            - string
            - 'null'
        facility_id:
          type:
            - string
            - 'null'
          format: uuid
        cpu_type:
          type:
            - string
            - 'null'
        memory_bytes:
          type:
            - integer
            - 'null'
          format: int64
        storage_bytes:
          type:
            - integer
            - 'null'
          format: int64
        ip:
          type: string
        port:
          type:
            - integer
            - 'null'
        username:
          type: string
        ssh_endpoint:
          type: string
        enrolled_at:
          type: string
          format: date-time
        cleanup_state:
          type: string
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
    NodeHealthReadiness:
      type: object
      description: >-
        Heartbeat-based launch preflight returned on reservation nodes. A stale
        heartbeat blocks launch. Missing heartbeat evidence returns ready true
        with heartbeat:unknown in advisory_reasons; this is not proof of host
        reachability, GPU health, or workload readiness. Treat an absent
        readiness object as unknown, not as ready. The reservation-node
        serializer returns an object, never null.
      required:
        - ready
        - status
        - reasons
        - advisory_reasons
      properties:
        ready:
          type: boolean
          description: Whether the heartbeat preflight reports no blocking reason.
        status:
          type: string
          enum:
            - ready
            - blocked
        reasons:
          type: array
          items:
            type: string
          description: Blocking reasons, such as heartbeat:stale.
        advisory_reasons:
          type: array
          items:
            type: string
          description: Nonblocking advisories, such as heartbeat:unknown.
      example:
        ready: false
        status: blocked
        reasons:
          - heartbeat:stale
        advisory_reasons: []
  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.