E2e2b-dev
sandboxes

Resume sandbox

Changed on

Resume the sandbox

post/sandboxes/{sandboxID}/resume

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/sandboxes/{sandboxID}/resume
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer and API key in header X-Team-ID
    • or API key in header X-Admin-Token and API key in header X-Team-ID
    • or HTTP bearer and API key in header X-Team-ID

Path parameters

sandboxIDstring required

Request body

timeoutinteger

Time to live for the sandbox in seconds.

autoPauseboolean

Automatically pauses the sandbox after the timeout

memoryboolean

Defaults to true. When false, resume from disk state only: the sandbox cold-boots fresh and any memory in the snapshot is ignored, never modified or deleted. Disk state has crash-recovery semantics — writes not flushed before the pause may be lost. A no-op for snapshots that contain no memory. Rejected with an error in environments where this capability is not enabled, never silently downgraded to a memory restore.

Response

The sandbox was resumed successfully

templateIDstring required

Identifier of the template from which is the sandbox created

sandboxIDstring required

Identifier of the sandbox

aliasstring

Alias of the template

clientIDstring required

Identifier of the client

envdVersionstring required

Version of the envd running in the sandbox

envdAccessTokenstring

Access token used for envd communication

trafficAccessTokenstring nullable

Token required for accessing sandbox via proxy.

domainstring nullable

Base domain where the sandbox traffic is accessible

Changes

  • a37f50c70019Revision changes
    • info

      added the non-success response with the status

  • fc7dc26a953dRevision changes
    • info

      the endpoint scheme security AdminJWTAuth AND AdminTeamAuth was added to the API

    • info

      added the new optional request property

    • info

      request body became optional