E2e2b-dev
sandboxes

Create sandbox (v2)

Changed on

Create a sandbox from the template. All system communication with the sandbox is secured.

post/v2/sandboxes

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/v2/sandboxes
  • 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

Headers

Idempotency-Keystring

Optional team-scoped key for retrying sandbox creation. Use 1 to 255 lowercase ASCII letters, digits, or hyphens (a-z, 0-9, -), such as a lowercase UUID. When idempotency is enabled, matching retries replay the original status and body, including errors, for the retention period. Different request parameters return 409 with error_code idempotency_request_mismatch. An in-progress request returns 409 with error_code idempotency_in_progress; an unknown outcome returns 422 with error_code idempotency_outcome_unknown. These retries do not execute the request again. Retries do not extend retention. After the key expires, it can start a new creation.

Request body

templateIDstring required

Identifier of the required template

timeoutinteger

Time to live for the sandbox in seconds.

autoPauseboolean

Automatically pauses the sandbox after the timeout

autoPauseMemoryboolean

Controls the snapshot kind taken when the sandbox auto-pauses on timeout (only relevant when autoPause is true). When false, the auto-pause drops the in-memory state and persists only the filesystem (a filesystem-only snapshot); resuming it cold-boots (reboots) the sandbox from disk. Such a snapshot cannot be auto-resumed by traffic and must be resumed explicitly, so it cannot be combined with autoResume. Defaults to true (full memory snapshot).

allow_internet_accessboolean

Allow sandbox to access the internet. When set to false, it behaves the same as specifying denyOut to 0.0.0.0/0 in the network config.

metadataunknown
envVarsunknown
mcpMcp nullable

MCP configuration for the sandbox

Response

The sandbox was created 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

  • 99fccbc60e6dRevision changes
    • info

      the request property / became nullable

    • info

      the request property default value true was removed

  • 04ec8eabc7f9Revision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status