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

> Lists one page of volumes owned by the API key's creator in its organization, most recently updated first. Follow next_cursor with the same filters until it is null. A cursor is tied to its filters; change a filter and start again from the first page. With reservation_id, the endpoint instead returns the volume attached to that reservation and its attachment, and accepts no other query parameter.

CLI equivalent: `ornn volumes list --limit 25 --format json`.


## OpenAPI

````yaml openapi.yaml GET /v1/orchestrator/drives
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/drives:
    get:
      tags:
        - Storage
      summary: List volumes
      description: >-
        Lists one page of volumes owned by the API key's creator in its
        organization, most recently updated first. Follow next_cursor with the
        same filters until it is null. A cursor is tied to its filters; change a
        filter and start again from the first page. With reservation_id, the
        endpoint instead returns the volume attached to that reservation and its
        attachment, and accepts no other query parameter.
      operationId: platformListVolumes
      parameters:
        - name: limit
          in: query
          required: false
          description: Page size from 1 to 100. Defaults to 15.
          schema:
            type: integer
            minimum: 1
            maximum: 100
          example: 25
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque next_cursor from the previous page, sent with the same
            filters.
          schema:
            type: string
        - name: q
          in: query
          required: false
          description: >-
            Case-insensitive text matched against volume name, ID, and region.
            At most 256 characters.
          schema:
            type: string
            maxLength: 256
        - name: deployment
          in: query
          required: false
          description: Filter by whether the volume is mounted on a machine.
          schema:
            type: string
            enum:
              - all
              - deployed
              - available
            default: all
        - name: reservation_id
          in: query
          required: false
          description: >-
            An owned reservation. Returns that reservation's attached volume and
            attachment instead of a page. Cannot be combined with other query
            parameters.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            A page of volumes, or the reservation's attachment when
            reservation_id is set. Ignore fields you do not recognize.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PlatformVolumePage'
                  - $ref: '#/components/schemas/PlatformReservationVolume'
              example:
                drives:
                  - id: 77777777-7777-4777-8777-777777777777
                    source_drive_id: null
                    name: training-data
                    status: active
                    size_bytes: 1073741824
                    file_count: 42
                    file_tree_status: ready
                    content_epoch: 7
                    source:
                      status: ready
                      region: us-central1
                      read_only: false
                      github_repositories: []
                    file_capabilities:
                      state: ready
                      can_upload: true
                      message: null
                    active_mount: null
                    active_mounts: []
                    created_at: '2026-10-01T12:00:00Z'
                    updated_at: '2026-10-14T12:00:00Z'
                next_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: Invalid page size, filter, or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: storage_page_invalid
                  message: >-
                    Choose a page size from 1 to 100 and valid storage filters,
                    or restart from the first page.
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    PlatformVolumePage:
      type: object
      required:
        - drives
      properties:
        drives:
          type: array
          items:
            $ref: '#/components/schemas/PlatformVolume'
        next_cursor:
          type:
            - string
            - 'null'
          description: >-
            Pass unchanged as cursor, with the same filters. null means the last
            page.
    PlatformReservationVolume:
      type: object
      description: The volume attached to a reservation, when reservation_id is set.
      required:
        - drives
        - attachment
      properties:
        drives:
          type: array
          description: Zero or one volume.
          items:
            $ref: '#/components/schemas/PlatformVolume'
        attachment:
          anyOf:
            - $ref: '#/components/schemas/PlatformVolumeAttachment'
            - type: 'null'
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
    PlatformVolume:
      type: object
      description: >-
        A volume. Responses can include additional fields; ignore fields you do
        not recognize.
      required:
        - id
        - name
        - status
      properties:
        id:
          type: string
          format: uuid
        source_drive_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The volume this one was duplicated from.
        name:
          type: string
        status:
          type: string
          description: active for a usable volume.
        size_bytes:
          type: integer
          format: int64
          description: Measured size. It can lag writes from mounted machines.
        file_count:
          type:
            - integer
            - 'null'
        file_tree:
          type: array
          description: >-
            A preview of recently updated files. Use List volume files for a
            complete listing.
          items:
            type: object
        file_tree_status:
          type: string
        content_epoch:
          type: integer
          format: int64
          description: Increases whenever the volume's files change.
        source:
          type: object
          properties:
            status:
              type: string
            region:
              type:
                - string
                - 'null'
              description: Storage region.
            read_only:
              type: boolean
            github_repositories:
              type: array
              items:
                $ref: '#/components/schemas/PlatformVolumeGithubRepository'
        file_capabilities:
          type: object
          properties:
            state:
              type: string
            can_upload:
              type: boolean
            message:
              type:
                - string
                - 'null'
        active_mount:
          anyOf:
            - $ref: '#/components/schemas/PlatformVolumeMount'
            - type: 'null'
        active_mounts:
          type: array
          items:
            $ref: '#/components/schemas/PlatformVolumeMount'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PlatformVolumeAttachment:
      type: object
      description: A reservation's volume attachment.
      properties:
        id:
          type: string
          format: uuid
        reservation_id:
          type: string
          format: uuid
        drive_id:
          type: string
          format: uuid
        mount_path:
          type: string
        mount_mode:
          type: string
        access_mode:
          type: string
          description: read-write or read-only.
        state:
          type: string
          description: >-
            pre_positioning while Ornn prepares the copy, ready when the copy is
            in place, failed, or detaching. Mounting on each machine follows
            ready; read the volume's active_mounts for per-machine state.
        error:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        drive:
          anyOf:
            - $ref: '#/components/schemas/PlatformVolume'
            - type: 'null'
        placement:
          anyOf:
            - $ref: '#/components/schemas/PlatformVolumePlacement'
            - type: 'null'
    PlatformVolumeGithubRepository:
      type: object
      description: A repository pulled into a folder of the volume.
      properties:
        folder:
          type: string
        full_name:
          type: string
        branch:
          type: string
        connection_id:
          type: string
          format: uuid
        sync:
          type: object
          description: The latest pull or sync of this folder.
          properties:
            state:
              type: string
              description: queued, running, ready, or failed.
            step:
              type: string
              description: While running, checking, downloading, writing, or promoting.
            requested_at:
              type: string
              format: date-time
            commit_sha:
              type: string
            error:
              type:
                - string
                - 'null'
              description: A customer-readable reason when state is failed.
    PlatformVolumeMount:
      type: object
      description: The volume's mount on one VM or Bare Metal node.
      properties:
        id:
          type: string
          format: uuid
        drive_id:
          type: string
          format: uuid
        reservation_id:
          type:
            - string
            - 'null'
          format: uuid
        node_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The Bare Metal node or the host delivering commands to the VM.
        virtual_machine_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The mounted VM. Null for a Bare Metal mount.
        mount_path:
          type: string
        access:
          type: string
          description: read-write or read-only.
        state:
          type: string
          description: >-
            reserved, provisioning, mounted, release_pending, failed, or stale.
            mounted means the volume is mounted on this VM or Bare Metal node.
            Handle unrecognized values without assuming readiness.
        error:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PlatformVolumePlacement:
      type: object
      description: The storage copy prepared next to the reservation's machines.
      properties:
        state:
          type: string
          description: pre_positioning, ready, failed, or stale.
        target_region:
          type: string
        error:
          type:
            - string
            - 'null'
        ready_at:
          type:
            - string
            - 'null'
          format: date-time
        transfer:
          type:
            - object
            - 'null'
          properties:
            state:
              type: string
            objects_total:
              type:
                - integer
                - 'null'
            objects_copied:
              type:
                - integer
                - 'null'
            bytes_total:
              type:
                - integer
                - 'null'
            bytes_copied:
              type:
                - integer
                - 'null'
            error:
              type:
                - string
                - 'null'
  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.