---
title: "Update a sandbox"
method: PATCH
path: "/v2/sandboxes/boxes/{name}"
tags: ["sandboxes"]
---

# Update a sandbox

`PATCH /v2/sandboxes/boxes/{name}`

Update a sandbox's display name. The name must be unique within the tenant.

## Path parameters

- `name` string, required

## Request body

- SandboxesUpdateSandboxPayload
  - `delete_after_stop_seconds` integer
  - `fs_capacity_bytes` integer
  - `idle_ttl_seconds` integer
  - `mem_bytes` integer
  - `name` string
  - `proxy_config` SandboxesProxyConfig
    - `access_control` SandboxesAccessControl
      - `allow_list` string[]
      - `deny_list` string[]
    - `callbacks` SandboxesCallback[]
      - `full_request` boolean
      - `match_hosts` string[], required
      - `request_headers` SandboxesProxyHeader[]
        - `is_set` boolean
        - `name` string, required
        - `type` 'plaintext' | 'opaque' | 'workspace_secret', required
        - `value` string
      - `ttl_seconds` integer, required
      - `url` string, required
    - `no_proxy` string[]
    - `rules` SandboxesProxyRule[]
      - `enabled` boolean
      - `headers` SandboxesProxyHeader[]
        - `is_set` boolean
        - `name` string, required
        - `type` 'plaintext' | 'opaque' | 'workspace_secret', required
        - `value` string
      - `match_hosts` string[], required
      - `match_paths` string[]
      - `name` string, required
  - `tag_value_ids` string[]
  - `vcpus` integer

## Response `200`

OK

- SandboxesSandboxResponse
  - `created_at` string
  - `created_by` string
  - `dataplane_url` string
  - `delete_after_stop_seconds` integer
  - `fs_capacity_bytes` integer
  - `id` string
  - `idle_ttl_seconds` integer
  - `mem_bytes` integer
  - `name` string
  - `proxy_config` SandboxesProxyConfig
    - `access_control` SandboxesAccessControl
      - `allow_list` string[]
      - `deny_list` string[]
    - `callbacks` SandboxesCallback[]
      - `full_request` boolean
      - `match_hosts` string[], required
      - `request_headers` SandboxesProxyHeader[]
        - `is_set` boolean
        - `name` string, required
        - `type` 'plaintext' | 'opaque' | 'workspace_secret', required
        - `value` string
      - `ttl_seconds` integer, required
      - `url` string, required
    - `no_proxy` string[]
    - `rules` SandboxesProxyRule[]
      - `enabled` boolean
      - `headers` SandboxesProxyHeader[]
        - `is_set` boolean
        - `name` string, required
        - `type` 'plaintext' | 'opaque' | 'workspace_secret', required
        - `value` string
      - `match_hosts` string[], required
      - `match_paths` string[]
      - `name` string, required
  - `size_class` string
  - `snapshot_id` string
  - `status` string
  - `status_message` string
  - `stopped_at` string
  - `updated_at` string
  - `updated_by` string
  - `vcpus` integer

## Other responses

- `404` — Not Found
- `409` — Name already exists
- `422` — Validation error
- `500` — Internal Server Error

## Changes

- **2026-05-27** `a0acb3a6a101` — 3 warning, 12 info
  - removed the request property `ttl_seconds`
  - removed the optional property `expires_at` from the response with the `200` status
  - removed the optional property `ttl_seconds` from the response with the `200` status
  - added the new optional request property `delete_after_stop_seconds`
  - …11 more
- **2026-04-30** `99490d1e837e` — 1 warning, 3 info
  - removed the optional property `template_name` from the response with the `200` status
  - added the new optional request property `proxy_config/callbacks`
  - added the optional property `proxy_config/callbacks` to the response with the `200` status
  - added the optional property `size_class` to the response with the `200` status
- **2026-04-13** `e86be67718ee` — 1 breaking, 1 warning, 10 info
  - removed the required property `proxy_config/rules/items/inject_headers` from the response with the `200` status
  - removed the request property `proxy_config/rules/items/inject_headers`
  - the endpoint scheme security `X-Service-Key` was added to the API
  - added the new optional request property `fs_capacity_bytes`
  - …8 more
- **2026-03-23** `aa05bc5a3c17` — 2 info
  - added the new optional request property `idle_ttl_seconds`
  - added the optional property `idle_ttl_seconds` to the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/langchain-ai/apis/langsmith/changes/v2/sandboxes/boxes/:name/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-service-production.skmtc.workers.dev/v1/apis/langchain-ai/langsmith/revisions/a0acb3a6a101/schema)