---
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

---

[API](https://skmtc.net/langchain-ai/apis/langsmith.md) · [All operations](https://skmtc.net/langchain-ai/apis/langsmith/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/langchain-ai/langsmith/versions/a0acb3a6a101/schema)