Skip to main content
POST
/
sandboxes
Create sandbox
curl --request POST \
  --url https://api.e2b.app/sandboxes \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "templateID": "<string>",
  "timeout": 15,
  "autoPause": false,
  "autoPauseMemory": true,
  "secure": true,
  "allow_internet_access": true,
  "network": {
    "allowPublicTraffic": true,
    "allowOut": [
      "<string>"
    ],
    "denyOut": [
      "<string>"
    ],
    "egressProxy": {
      "address": "<string>",
      "username": "<string>",
      "password": "<string>"
    },
    "maskRequestHost": "<string>",
    "rules": {}
  },
  "metadata": {},
  "envVars": {},
  "mcp": {},
  "volumeMounts": [
    {
      "name": "<string>",
      "path": "<string>"
    }
  ]
}
'
{
  "templateID": "<string>",
  "sandboxID": "<string>",
  "clientID": "<string>",
  "envdVersion": "<string>",
  "alias": "<string>",
  "envdAccessToken": "<string>",
  "trafficAccessToken": "<string>",
  "domain": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
templateID
string
required

Identifier of the required template

​
timeout
integer<int32>
default:15

Time to live for the sandbox in seconds.

Required range: x >= 0
​
autoPause
boolean
default:false

Automatically pauses the sandbox after the timeout

​
autoPauseMemory
boolean
default:true

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).

​
autoResume
object

Auto-resume configuration for paused sandboxes.

​
secure
boolean

Secure all system communication with sandbox

​
allow_internet_access
boolean

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.

​
network
object
​
metadata
object
​
envVars
object
​
mcp
object

MCP configuration for the sandbox

​
volumeMounts
object[]

Response

The sandbox was created successfully

​
templateID
string
required

Identifier of the template from which is the sandbox created

​
sandboxID
string
required

Identifier of the sandbox

​
clientID
string
required
deprecated

Identifier of the client

​
envdVersion
string
required

Version of the envd running in the sandbox

​
alias
string

Alias of the template

​
envdAccessToken
string | null

Access token for authenticating envd requests to this sandbox. Only returned when the sandbox is created with secure: true. Null for non-secure sandboxes (envd endpoints work without auth).

​
trafficAccessToken
string | null

Token required for accessing sandbox via proxy.

​
domain
string | null
deprecated

Deprecated: always null. Construct sandbox URLs as https://{port}-{sandboxID}.e2b.app.