Skip to content

docs(sdk): onResume needs a control plane that knows the option #1859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bchalios merged 1 commit into from
Sep 10, 2026
+36 −0
Merged

docs(sdk): onResume needs a control plane that knows the option #1859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/on-resume-control-plane-caveat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 6 additions & 0 deletions packages/js-sdk/src/sandbox/sandboxApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
12 changes: 12 additions & 0 deletions packages/python-sdk/e2b/sandbox_async/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,10 @@ async def connect(
Rejected where filesystem-only resume is not enabled; a no-op for a snapshot
without memory or a sandbox that is already running. A value outside the two
literals 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
Expand Down Expand Up @@ -322,6 +326,10 @@ async def connect(
Rejected where filesystem-only resume is not enabled; a no-op for a snapshot
without memory or a sandbox that is already running. A value outside the two
literals 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
Expand Down Expand Up @@ -356,6 +364,10 @@ async def connect(
Rejected where filesystem-only resume is not enabled; a no-op for a snapshot
without memory or a sandbox that is already running. A value outside the two
literals 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
Expand Down
12 changes: 12 additions & 0 deletions packages/python-sdk/e2b/sandbox_sync/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,10 @@ def connect(
Rejected where filesystem-only resume is not enabled; a no-op for a snapshot
without memory or a sandbox that is already running. A value outside the two
literals 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
Expand Down Expand Up @@ -317,6 +321,10 @@ def connect(
Rejected where filesystem-only resume is not enabled; a no-op for a snapshot
without memory or a sandbox that is already running. A value outside the two
literals 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
Expand Down Expand Up @@ -351,6 +359,10 @@ def connect(
Rejected where filesystem-only resume is not enabled; a no-op for a snapshot
without memory or a sandbox that is already running. A value outside the two
literals 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
Expand Down
Loading