---
title: "Attaches disks to a VM in the project and returns the async operation."
method: POST
path: "/projects/{project_id}/compute/vms/instances/{vm_id}/attach-disks"
tags: ["VMs"]
---

# Attaches disks to a VM in the project and returns the async operation.

`POST /projects/{project_id}/compute/vms/instances/{vm_id}/attach-disks`

## Request

- Base URL: `https://api.cloud.crusoe.ai/v1`
- URL: `https://api.cloud.crusoe.ai/v1/projects/{project_id}/compute/vms/instances/{vm_id}/attach-disks`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crusoecloud/apis/crusoe-cloud-api-gateway/docs/projects/:project_id/compute/vms/instances/:vm_id/attach-disks/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `project_id` string, required
- `vm_id` string, required

## Request body

- InstancesAttachDiskPostRequestV1: InstancesAttachDiskPostRequestV1 is the request type for POST requests to the vms.instances.attach-disk endpoint.
  - `attach_disks` DiskAttachment[], required: Disks to attach to the VM.
    - `attachment_type` 'os' | 'data', required: Role the disk plays for the VM: os or data.
    - `disk_id` string, required: ID of the disk to attach.
    - `mode` 'read-only' | 'read-write', required: Access mode to attach the disk with: read-only or read-write.

## Response `200`

- AsyncOperationResponse
  - `operation` Operation, required: Individual resources that use Operations should populate the `metadata` field with resource-specific information.
    - `completed_at` string, required
    - `metadata` string, required
    - `operation_id` string, required
    - `result` string
    - `started_at` string, required
    - `state` 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED', required

## Other responses

- `400`: Error Bad Request
- `401`: Error Authentication Failed
- `403`: Error Permissions
- `500`: Error Internal Server

---

[API](https://skmtc.dev/crusoecloud/apis/crusoe-cloud-api-gateway.md) - [All operations](https://skmtc.dev/crusoecloud/apis/crusoe-cloud-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/crusoecloud/apis/crusoe-cloud-api-gateway/revisions/a3fd2dedc72b?raw)