---
title: "Attach a machine default volume"
method: POST
path: "/v1/machine/volumes"
tags: ["Agent environments"]
---

# Attach a machine default volume

`POST /v1/machine/volumes`

## Request

- Base URL: `https://api.shardflux.dev`
- URL: `https://api.shardflux.dev/v1/machine/volumes`
- Auth: HTTP bearer

## Query parameters

- `project_id` string, uuid
- `repo_remote` string

## Request body

- object
  - `project_id` string, uuid: UUIDv7, lowercase canonical form.
  - `repo_remote` string
  - `volume_id` string, uuid: UUIDv7, lowercase canonical form.
  - `name` string
  - `mount_path` string, required
  - `mode` union
    - 'ro'
    - 'rw'

## Response `200`

Default Response

- object
  - `volumes` object[], required
    - `id` string, uuid, required
    - `volume_id` string, uuid, required
    - `name` string, required
    - `mount_path` string, required
    - `mode` union, required
      - 'ro'
      - 'rw'
    - `source` union, required
      - 'machine'
      - 'template'
  - `live` object[], required
    - `workspace_id` string, uuid, required: UUIDv7, lowercase canonical form.
    - `volume_id` string, uuid, required: UUIDv7, lowercase canonical form.
    - `status` string, required
    - `reason` string
    - `operation_id` string, uuid: UUIDv7, lowercase canonical form.

## Other responses

- `4XX`: Default Response
- `5XX`: Default Response

---

[API](https://skmtc.dev/shardflux/apis/shardflux-api.md) · [All operations](https://skmtc.dev/shardflux/apis/shardflux-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shardflux/apis/shardflux-api/revisions/ea685f7b39c4?raw)