Open-source, secure environment with real-world tools for enterprise-grade agents.
Python agentaiai-agentai-agentscode-interpretercopilotdevelopmentdevtoolsgptgpt-4javascriptllmnextjsopenaipythonreactsoftwaretypescript
docs(sdk): onResume needs a control plane that knows the option (#1859)
Babis Chalios5e418dcc3e60
diff --git a/.changeset/on-resume-control-plane-caveat.md b/.changeset/on-resume-control-plane-caveat.mdnew file mode 100644index 000000000..19c4b68e1--- /dev/null+++ b/.changeset/on-resume-control-plane-caveat.md@@ -0,0 +1,6 @@+---+"e2b": patch+"@e2b/python-sdk": patch+---++Document that `onResume` / `on_resume` needs a control plane that knows the option: an older self-hosted or BYOC control plane drops the `memory` field and restores memory while reporting success, instead of rejecting the request.diff --git a/packages/js-sdk/src/sandbox/sandboxApi.ts b/packages/js-sdk/src/sandbox/sandboxApi.tsindex 0b6f215a5..2e5307f15 100644--- a/packages/js-sdk/src/sandbox/sandboxApi.ts+++ b/packages/js-sdk/src/sandbox/sandboxApi.ts@@ -710,6 +710,12 @@ export type SandboxConnectOpts = ConnectionOpts & {* is not enabled; a no-op for a snapshot without memory or a sandbox that is* already running.*+ * Needs a control plane that knows this option: E2B Cloud, or a self-hosted+ * or BYOC deployment built from `e2b-dev/infra` at or after the commit that+ * added the `memory` field to connect/resume (2026-08-20). An older control+ * plane drops the field and restores memory while answering as if the+ * request had succeeded.+ ** @default 'restore'* @throws {@link InvalidArgumentError} if the value is outside the two literals.*/diff --git a/packages/python-sdk/e2b/sandbox_async/main.py b/packages/python-sdk/e2b/sandbox_async/main.pyindex e3912b270..35ed4c1e9 100644--- a/packages/python-sdk/e2b/sandbox_async/main.py+++ b/packages/python-sdk/e2b/sandbox_async/main.py@@ -284,6 +284,10 @@ class AsyncSandbox(SandboxApi):Rejected where filesystem-only resume is not enabled; a no-op for a snapshotwithout memory or a sandbox that is already running. A value outside the twoliterals raises `InvalidArgumentException`.+ Needs a control plane that knows this option: E2B Cloud, or a self-hosted or BYOC+ deployment built from `e2b-dev/infra` at or after the commit that added the `memory`+ field to connect/resume (2026-08-20). An older control plane drops the field and+ restores memory while answering as if the request had succeeded.:return: A running sandbox instance@example@@ -322,6 +326,10 @@ class AsyncSandbox(SandboxApi):Rejected where filesystem-only resume is not enabled; a no-op for a snapshotwithout memory or a sandbox that is already running. A value outside the twoliterals raises `InvalidArgumentException`.+ Needs a control plane that knows this option: E2B Cloud, or a self-hosted or BYOC+ deployment built from `e2b-dev/infra` at or after the commit that added the `memory`+ field to connect/resume (2026-08-20). An older control plane drops the field and+ restores memory while answering as if the request had succeeded.:return: A running sandbox instance@example@@ -356,6 +364,10 @@ class AsyncSandbox(SandboxApi):Rejected where filesystem-only resume is not enabled; a no-op for a snapshotwithout memory or a sandbox that is already running. A value outside the twoliterals raises `InvalidArgumentException`.+ Needs a control plane that knows this option: E2B Cloud, or a self-hosted or BYOC+ deployment built from `e2b-dev/infra` at or after the commit that added the `memory`+ field to connect/resume (2026-08-20). An older control plane drops the field and+ restores memory while answering as if the request had succeeded.:return: A running sandbox instance@examplediff --git a/packages/python-sdk/e2b/sandbox_sync/main.py b/packages/python-sdk/e2b/sandbox_sync/main.pyindex 976d7c357..d252c54f3 100644--- a/packages/python-sdk/e2b/sandbox_sync/main.py+++ b/packages/python-sdk/e2b/sandbox_sync/main.py@@ -278,6 +278,10 @@ class Sandbox(SandboxApi):Rejected where filesystem-only resume is not enabled; a no-op for a snapshotwithout memory or a sandbox that is already running. A value outside the twoliterals raises `InvalidArgumentException`.+ Needs a control plane that knows this option: E2B Cloud, or a self-hosted or BYOC+ deployment built from `e2b-dev/infra` at or after the commit that added the `memory`+ field to connect/resume (2026-08-20). An older control plane drops the field and+ restores memory while answering as if the request had succeeded.:return: A running sandbox instance@example@@ -317,6 +321,10 @@ class Sandbox(SandboxApi):Rejected where filesystem-only resume is not enabled; a no-op for a snapshotwithout memory or a sandbox that is already running. A value outside the twoliterals raises `InvalidArgumentException`.+ Needs a control plane that knows this option: E2B Cloud, or a self-hosted or BYOC+ deployment built from `e2b-dev/infra` at or after the commit that added the `memory`+ field to connect/resume (2026-08-20). An older control plane drops the field and+ restores memory while answering as if the request had succeeded.:return: A running sandbox instance@example@@ -351,6 +359,10 @@ class Sandbox(SandboxApi):Rejected where filesystem-only resume is not enabled; a no-op for a snapshotwithout memory or a sandbox that is already running. A value outside the twoliterals raises `InvalidArgumentException`.+ Needs a control plane that knows this option: E2B Cloud, or a self-hosted or BYOC+ deployment built from `e2b-dev/infra` at or after the commit that added the `memory`+ field to connect/resume (2026-08-20). An older control plane drops the field and+ restores memory while answering as if the request had succeeded.:return: A running sandbox instance@example