| Name | Type | Description |
|---|---|---|
name* | str | Current sandbox name. |
new_name | Optional[str] | Default: NoneNew display name. |
idle_ttl_seconds | Optional[int] | Default: None |
delete_after_stop_seconds | Optional[int] | Default: None |
proxy_config | Optional[SandboxProxyConfig] | Default: None |
run_config | Optional[Union[RunConfig, dict[str, Any]]] | Default: None |
Update a sandbox's properties.
Idle timeout in seconds. Must be a multiple of
60. 0 disables idle-stop. None leaves the existing
value unchanged.
Seconds after entering stopped
before deletion. Must be a multiple of 60. 0 disables
stop-anchored deletion. None leaves the existing value
unchanged.
Replacement proxy configuration, forwarded to the
server as-is (same shape as create_sandbox). 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.
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.
