> ## 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 volume files

> Lists one folder level of the volume, folders first, 200 entries per page. Set recursive=true or search to list matching files at any depth instead. Pass next_cursor unchanged with the same path and search to read the next page.

CLI equivalent: `ornn volumes files list <volume> --format json`.


## OpenAPI

````yaml openapi.yaml GET /v1/orchestrator/drives/{drive_id}/contents
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/{drive_id}/contents:
    parameters:
      - $ref: '#/components/parameters/PlatformDriveId'
    get:
      tags:
        - Storage
      summary: List volume files
      description: >-
        Lists one folder level of the volume, folders first, 200 entries per
        page. Set recursive=true or search to list matching files at any depth
        instead. Pass next_cursor unchanged with the same path and search to
        read the next page.
      operationId: platformListVolumeFiles
      parameters:
        - name: path
          in: query
          required: false
          description: Folder to list, relative to the volume root. Omit for the root.
          schema:
            type: string
          example: results/run1
        - name: search
          in: query
          required: false
          description: Case-insensitive text matched against file paths at any depth.
          schema:
            type: string
        - name: recursive
          in: query
          required: false
          description: List every file below path instead of one folder level.
          schema:
            type: boolean
            default: false
        - name: cursor
          in: query
          required: false
          description: next_cursor from the previous page.
          schema:
            type: string
      responses:
        '200':
          description: One page of entries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformVolumeContents'
              example:
                path: results
                entries:
                  - path: results/run1
                    name: run1
                    kind: directory
                  - path: results/summary.csv
                    name: summary.csv
                    kind: file
                    size_bytes: 2048
                    updated_at: '2026-10-14T12:00:00Z'
                total: 2
                next_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/PlatformVolumeNotFound'
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    PlatformDriveId:
      name: drive_id
      in: path
      required: true
      description: Volume ID.
      schema:
        type: string
        format: uuid
      example: 77777777-7777-4777-8777-777777777777
  schemas:
    PlatformVolumeContents:
      type: object
      properties:
        path:
          type: string
        search:
          type: string
        entries:
          type: array
          items:
            $ref: '#/components/schemas/PlatformVolumeEntry'
        total:
          type: integer
          description: >-
            Entries at this level, or matches on this page for a recursive or
            search listing.
        next_cursor:
          description: Pass unchanged as cursor. null means the last page.
          oneOf:
            - type: string
            - type: integer
            - type: 'null'
    PlatformVolumeEntry:
      type: object
      properties:
        path:
          type: string
          description: Path relative to the volume root.
        name:
          type: string
        kind:
          type: string
          enum:
            - file
            - directory
        size_bytes:
          type: integer
          format: int64
        updated_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, 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'
    PlatformVolumeNotFound:
      description: The volume does not exist or is not one of your volumes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              code: storage_drive_not_found
              message: Ornn could not find that volume.
    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.