---
title: "[Beta] Update a volume"
method: PATCH
path: "/api/v2/sandboxes/volumes/{volume}"
tags: ["sandboxes"]
---

# \[Beta\] Update a volume

`PATCH /api/v2/sandboxes/volumes/{volume}`

## Request

- Base URL: `https://api.smith.langchain.com`
- URL: `https://api.smith.langchain.com/api/v2/sandboxes/volumes/{volume}`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in header `X-Tenant-Id`
  - HTTP bearer

**Beta:** This API is in active development and may change without notice. Requires sandbox volumes to be enabled for your workspace. Update a volume's description or labels. Each field sent replaces the stored value; omitted fields are unchanged. Null, an empty description, or an empty labels object clears it. Only the volume's creator, or a role with sandboxes:exec, may update it.

## Path parameters

- `volume` string, required

## Request body

- SandboxesUpdateVolumePayload
  - `description` string, nullable: Description replaces the description; null or an empty string clears it.
  - `labels` object, nullable: Labels replaces every label; null or an empty object clears them.

## Response `200`

OK

- SandboxesVolumeResponse
  - `attachments` SandboxesVolumeAttachmentResponse[]
    - `mount_path` string
    - `read_only` boolean
    - `sandbox_id` string
    - `sandbox_name` string
  - `created_at` string, date-time
  - `created_by` string
  - `description` string
  - `id` string
  - `labels` SandboxesLabels
  - `name` string
  - `size_bytes` integer
  - `source_volume_id` string
  - `status` string
  - `status_message` string
  - `updated_at` string, date-time
  - `updated_by` string

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-10-26** `dfe647d1748e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/langchain-ai/apis/langsmith/changes/api/v2/sandboxes/volumes/:volume/patch.md)

---

[API](https://skmtc.dev/langchain-ai/apis/langsmith.md) - [All operations](https://skmtc.dev/langchain-ai/apis/langsmith/llms.txt) - [OpenAPI document](https://skmtc.dev/langchain-ai/apis/langsmith/revisions/7a01c01f75e8?raw)
