LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangSmith
  • Client
  • Run Trees
  • Traceable
  • Evaluation
  • Schemas
  • Langchain
  • Jest
  • Vitest
  • Wrappers
  • Anonymizer
  • Jestlike
  • Vercel
  • Anthropic
  • Sandbox
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangSmith
ClientRun TreesTraceableEvaluationSchemasLangchainJestVitestWrappersAnonymizerJestlikeVercelAnthropicSandbox
Language
Theme
JavaScriptlangsmithsandboxUpdateSandboxOptions
Interface●Since v0.8

UpdateSandboxOptions

Options for updating a sandbox (name, retention settings, proxy config).

Copy
interface UpdateSandboxOptions

Properties

property
deleteAfterStopSeconds: number

Seconds after entering stopped before deletion. Must be a multiple of 60. Pass 0 to disable stop-anchored deletion. Omit (or pass undefined) to leave the existing value unchanged.

property
idleTtlSeconds: number

Idle timeout in seconds. Must be a multiple of 60. Pass 0 to disable the idle stop. Omit (or pass undefined) to leave the existing value unchanged.

property
newName: string

New display name.

property
proxyConfig: SandboxProxyConfig

Replacement proxy configuration, sent to the server as-is (same shape as createSandbox). Rules replace the existing set rather than merging into it, so include every rule the sandbox should keep. Opaque header values carry over from the current config, so rotating one credential does not mean re-supplying secrets that can no longer be read. The sandbox must be ready; start a stopped one first.

property
runConfig: RunConfig

Merge into the sandbox's stored run configuration: user and work_dir replace, env_vars merge. Takes effect for subsequent commands; commands already running are unaffected, and a stopped sandbox picks it up on its next start. Omitting it leaves the stored value untouched.

View source on GitHub