> ## 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. # Attach or detach a volume > Attaches the volume to an owned reservation with deployed true, or detaches it with attached false. Ornn mounts an attached volume on every machine in the reservation; there is no per-machine selection. Every machine in the reservation must be online. A reservation holds one volume at a time, and a volume attaches to one reservation at a time. To change the access mode or mount path, detach first. Both operations are asynchronous: poll List volumes with reservation_id. Detaching keeps the volume and its data and does not change reservation billing. CLI equivalents: `ornn volume-mounts attach --volume --access read-write` and `ornn volume-mounts detach `. See [Manage volumes through the API](/guides/storage-pricing#manage-volumes-through-the-api) for the polling sequence. ## OpenAPI ````yaml openapi.yaml PATCH /v1/orchestrator/drives/{drive_id} 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}: parameters: - $ref: '#/components/parameters/PlatformDriveId' patch: tags: - Storage summary: Attach or detach a volume description: >- Attaches the volume to an owned reservation with deployed true, or detaches it with attached false. Ornn mounts an attached volume on every machine in the reservation; there is no per-machine selection. Every machine in the reservation must be online. A reservation holds one volume at a time, and a volume attaches to one reservation at a time. To change the access mode or mount path, detach first. Both operations are asynchronous: poll List volumes with reservation_id. Detaching keeps the volume and its data and does not change reservation billing. operationId: platformUpdateVolumeAttachment requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformVolumeAttachmentChange' examples: attach: summary: Attach read-write value: reservation_id: 11111111-1111-4111-8111-111111111111 deployed: true access_mode: read-write mount_path: /home/tenant/volume detach: summary: Detach value: reservation_id: 11111111-1111-4111-8111-111111111111 attached: false responses: '200': description: >- The request was accepted. attachment.state is pre_positioning after an attach and detaching after a detach. attachment is null when there was nothing to detach. content: application/json: schema: $ref: '#/components/schemas/PlatformVolumeAttachmentEnvelope' example: attachment: id: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa reservation_id: 11111111-1111-4111-8111-111111111111 drive_id: 77777777-7777-4777-8777-777777777777 mount_path: /home/tenant/volume mount_mode: fuse access_mode: read-write state: pre_positioning error: null created_at: '2026-10-14T12:05:00Z' placement: state: pre_positioning target_region: us-central1 error: null ready_at: null transfer: state: queued objects_total: null objects_copied: null bytes_total: null bytes_copied: null error: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The volume or reservation is not visible to your organization. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- The change conflicts with current state, such as an offline machine, a volume attached elsewhere, a detach in progress, or a change that requires detaching first. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: storage_reservation_node_offline message: >- A node in this reservation is offline. Bring every node online. '422': description: The reservation's location cannot hold storage yet. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: storage_location_unavailable message: >- Ornn cannot place storage for this reservation location yet. Ask Ornn Support to set a storage region for the facility. 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: PlatformVolumeAttachmentChange: type: object required: - reservation_id properties: reservation_id: type: string format: uuid description: An owned reservation. deployed: type: boolean description: >- Set true to attach and mount the volume on every machine in the reservation. attached: type: boolean description: Set false to detach the volume from the reservation. access_mode: type: string enum: - read-write - read-only default: read-write mount_path: type: string default: /home/tenant/volume description: Absolute path on each machine. PlatformVolumeAttachmentEnvelope: type: object required: - attachment properties: 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 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' 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 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' 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 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.