sandboxes

Update a sandbox

Changed on Oct 26, 2026

Update a sandbox's display name, retention, resources, tags, or proxy configuration. The name must be unique within the tenant. Proxy configuration sent to a sandbox that is not running is stored and applied when it next starts.

patch/api/v2/sandboxes/boxes/{name}

Request

Base URL
https://api.smith.langchain.com
URL
https://api.smith.langchain.com/api/v2/sandboxes/boxes/{name}
Auth
- API key in header X-API-Key
- or API key in header X-Tenant-Id
- or HTTP bearer
- or X-Service-Key (a scheme the document does not define)

Path parameters

namestring required

Current sandbox display name

Request body

cpu_millicoresinteger

delete_after_stop_secondsinteger

fs_capacity_bytesinteger

idle_ttl_secondsinteger

mem_bytesinteger

New memory for the sandbox, in bytes. The 4 GiB per vCPU ratio applies when the sandbox is created; a resize enforces only the maximum of 64 GiB.

namestring

tag_value_idsstring[]

vcpusinteger

Response

cpu_millicoresinteger

created_atstring

created_bystring

dataplane_urlstring

delete_after_stop_secondsinteger

fs_capacity_bytesinteger

idstring

idle_ttl_secondsinteger

labelsSandboxesLabels

mem_bytesinteger

mount_configSandboxesSandboxMountConfig (unresolved $ref)

namestring

persistentboolean

Persistent (private beta) reports whether the sandbox keeps its filesystem across stops. When false, its writes are discarded whenever it stops and it is not charged for storage.

preserve_memory_on_stopboolean

size_classstring

snapshot_idstring

statusstring

status_messagestring

stopped_atstring

updated_atstring

updated_bystring