Request body

• templateIDstring必填

  Template ID or alias from templates.list; resolves to your ready Environment first, then a public Base. Supply it explicitly.

• timeoutinteger可选
  默认 15

  Time to live for the sandbox in seconds.

• autoPauseboolean可选
  默认 false

  Automatically pauses the sandbox after the timeout

• metadataany可选
• envVarsany可选
• secureboolean可选

  Secure all system communication with sandbox

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

• autoPauseMemoryboolean可选
  默认 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).

• autoResumeobject可选

  Auto-resume configuration for paused sandboxes.

  ▸ 展开子字段（1）

  • enabledboolean必填
    默认 false

    Auto-resume enabled flag for paused sandboxes. Default false.

• networkobject可选
  ▸ 展开子字段（7）

  • allowPublicTrafficboolean可选
    默认 true

    Specify if the sandbox URLs should be accessible only with authentication.

  • allowOutarray可选

    List of allowed destinations for egress traffic. Each entry can be a CIDR block (e.g. "8.8.8.8/32"), a bare IP address (e.g. "8.8.8.8"), or a domain name (e.g. "example.com", "*.example.com"). Allowed entries always take precedence over denied entries.

  • denyOutarray可选

    List of denied CIDR blocks or IP addresses for egress traffic. Domain names are not supported for deny rules.

  • egressProxyobject可选

    SOCKS5 proxy for sandbox egress. Outbound TCP is tunneled through the proxy after allow/deny filtering; the sandbox is unaware. Domain-matched flows use remote DNS (ATYP=domain).

  • maskRequestHoststring可选

    Specify host mask which will be used for all sandbox requests

  • httpsPortsarray可选

    Unlike E2B, network.httpsPorts is rejected; omit it and serve plaintext HTTP inside the sandbox. The public port URL still uses HTTPS. The upstream field denotes HTTPS-speaking internal ports, permits self-signed certificates and excludes envd port 49983.

  • rulesobject可选

    Per-domain transform rules applied to matching outbound HTTPS requests. Keys may be exact DNS names (for example, "api.example.com") or a leading wildcard (for example, "*.example.com"), and are normalized to lowercase on write. Wildcards match subdomains at any depth but not the apex domain; a bare "*" is invalid. Exact rules take precedence, followed by the longest matching wildcard suffix, and matching rule sets are not merged. Broad wildcards such as "*.com" are allowed and may expose transformed credentials to every matching destination the sandbox contacts. Rules do not grant network access; configure allowOut separately to permit the destination.

• ▸ 更多参数（3）

  • mcpobject可选

    MCP configuration for the sandbox

  • iamobject可选

    Sandbox workload identity configuration. A non-empty, valid tokens map enables workload identity for the sandbox.

    ▸ 展开子字段（1）

    • tokensobject可选

      Named workload-token definitions, keyed by a caller-chosen token name.

  • volumeMountsarray可选
    ▸ 展开子字段（2）

    • namestring必填

      Name of the volume

    • pathstring必填

      Path of the volume

Returns

201

Deprecated: the latest official SDK uses v2. The platform does not provide E2B's default base template yet: Sandbox.create() without a template returns 404, so name a template explicitly (see List templates for what is available).

Errors follow the E2B format — see error codes

Request parameters

• metadatastring可选

  query: Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded.

Returns

200

Deprecated: the latest official SDK uses v2.

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• startinteger可选

  query: Unix timestamp for the start of the interval, in seconds, for which the metrics

• endinteger可选

  query: Unix timestamp for the end of the interval, in seconds, for which the metrics

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• timeoutinteger必填

  Timeout in seconds from the current time after which the sandbox should expire

Returns

204

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• memoryboolean可选
  默认 true

  Whether to capture a full memory snapshot. When false, only the filesystem is persisted and resuming the sandbox cold-boots (reboots) it from disk, losing in-memory state, running processes, and open connections. Resume it with an explicit request (connect or resume); auto-resume, which can be triggered by arbitrary traffic, refuses such a sandbox. Defaults to true.

Returns

204

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• timeoutinteger必填

  Timeout in seconds from the current time after which the sandbox should expire

• memoryboolean可选

  Defaults to true. When false and the sandbox is paused, 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.

Returns

201

Deprecated: the latest official SDK uses v2.

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

Returns

204

Errors follow the E2B format — see error codes

Request body

• templateIDstring必填

  Template ID or alias from templates.list; resolves to your ready Environment first, then a public Base. Supply it explicitly.

• timeoutinteger可选
  默认 300

  Time to live for the sandbox in seconds.

• autoPauseboolean可选
  默认 false

  Automatically pauses the sandbox after the timeout

• metadataany可选
• envVarsany可选
• 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.

• autoPauseMemoryboolean可选
  默认 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).

• autoResumeobject可选

  Auto-resume configuration for paused sandboxes.

  ▸ 展开子字段（1）

  • enabledboolean必填
    默认 false

    Auto-resume enabled flag for paused sandboxes. Default false.

• networkobject可选
  ▸ 展开子字段（7）

  • allowPublicTrafficboolean可选
    默认 true

    Specify if the sandbox URLs should be accessible only with authentication.

  • allowOutarray可选

    List of allowed destinations for egress traffic. Each entry can be a CIDR block (e.g. "8.8.8.8/32"), a bare IP address (e.g. "8.8.8.8"), or a domain name (e.g. "example.com", "*.example.com"). Allowed entries always take precedence over denied entries.

  • denyOutarray可选

    List of denied CIDR blocks or IP addresses for egress traffic. Domain names are not supported for deny rules.

  • egressProxyobject可选

    SOCKS5 proxy for sandbox egress. Outbound TCP is tunneled through the proxy after allow/deny filtering; the sandbox is unaware. Domain-matched flows use remote DNS (ATYP=domain).

  • maskRequestHoststring可选

    Specify host mask which will be used for all sandbox requests

  • httpsPortsarray可选

    Unlike E2B, network.httpsPorts is rejected; omit it and serve plaintext HTTP inside the sandbox. The public port URL still uses HTTPS. The upstream field denotes HTTPS-speaking internal ports, permits self-signed certificates and excludes envd port 49983.

  • rulesobject可选

    Per-domain transform rules applied to matching outbound HTTPS requests. Keys may be exact DNS names (for example, "api.example.com") or a leading wildcard (for example, "*.example.com"), and are normalized to lowercase on write. Wildcards match subdomains at any depth but not the apex domain; a bare "*" is invalid. Exact rules take precedence, followed by the longest matching wildcard suffix, and matching rule sets are not merged. Broad wildcards such as "*.com" are allowed and may expose transformed credentials to every matching destination the sandbox contacts. Rules do not grant network access; configure allowOut separately to permit the destination.

• mcpobject可选

  MCP configuration for the sandbox

• ▸ 更多参数（2）

  • iamobject可选

    Sandbox workload identity configuration. A non-empty, valid tokens map enables workload identity for the sandbox.

    ▸ 展开子字段（1）

    • tokensobject可选

      Named workload-token definitions, keyed by a caller-chosen token name.

  • volumeMountsarray可选
    ▸ 展开子字段（2）

    • namestring必填

      Name of the volume

    • pathstring必填

      Path of the volume

Returns

201

Errors follow the E2B format — see error codes

Request parameters

• metadatastring可选

  query: Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded.

• statearray可选

  query: Filter sandboxes by one or more states

• orderstring可选
  默认 "desc"

  query: Sort direction by sandbox start time. Defaults to desc (newest first).

  取值 ascdesc
• startedAfterstring可选

  query: Return sandboxes started at or after this timestamp.

• templatestring可选

  query: Filter sandboxes by a template ID or alias.

• nextTokenstring可选

  query: Cursor to start the list from

• limitinteger可选
  默认 100

  query: Maximum number of items to return per page

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• timeoutinteger可选
  默认 300

  Timeout in seconds from the current time after which the sandbox should expire

• memoryboolean可选

  Defaults to true. When false and the sandbox is paused, 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.

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• teamIDstring可选

  query: Identifier of the team

Returns

200

Deprecated: the latest official SDK uses v2.

Errors follow the E2B format — see error codes

Request parameters

• teamIDstring可选

  query: Identifier of the team

• nextTokenstring可选

  query: Cursor to start the list from

• limitinteger可选
  默认 100

  query: Maximum number of items to return per page

Returns

200

Errors follow the E2B format — see error codes

Request body

• namestring必填

  Name of the volume

Returns

201

Errors follow the E2B format — see error codes

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• volumeIDstring必填

  path:

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• volumeIDstring必填

  path:

Returns

204

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• timeoutinteger可选
  默认 15

  Time to live for each fork in seconds.

• countinteger可选
  默认 1

  Number of independent forks from one snapshot; each entry reports its own result or error.

Returns

201

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• namestring可选

  Optional alias. Reusing it within your subject updates the existing snapshot and retains its platform ID.

Returns

201

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring可选

  query: Filter by source sandbox ID.

• namestring可选

  query: Filter by the original user alias or platform snap_ snapshot ID.

• limitinteger可选
  默认 100

  query: Maximum snapshots per page.

• nextTokenstring可选

  query: Cursor from the previous response's X-Next-Token header.

Returns

200

Errors follow the E2B format — see error codes

Request parameters

• templateIDstring必填

  path: The snap_ snapshot ID returned by this platform. Vendor handles are not accepted.

Returns

204

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• allow_internet_accessboolean可选

  Allow internet access; false is equivalent to denyOut containing 0.0.0.0/0.

• allowOutarray可选

  Allowed egress CIDRs, IPs or domains; allow rules take precedence over deny rules.

• denyOutarray可选

  Denied egress CIDRs or IPs; domains are not supported.

• egressProxyobject可选

  Upstream proxy configuration; not currently applied by this platform.

  ▸ 展开子字段（3）

  • addressstring必填

    SOCKS5 proxy address in host:port format (e.g. "proxy.example.com:1080").

  • usernamestring可选

    Optional SOCKS5 username (RFC 1929), max 255 bytes.

  • passwordstring可选

    Optional SOCKS5 password (RFC 1929), max 255 bytes.

• rulesobject可选

  Upstream per-domain transform rules; not currently applied by this platform.

Returns

204

Errors follow the E2B format — see error codes

Request parameters

• sandboxIDstring必填

  path:

• cursorinteger可选

  query: Starting timestamp in Unix milliseconds.

• limitinteger可选
  默认 1000

  query: Maximum log entries to return.

• directionstring可选

  query: Read forward or backward in time.

  取值 forwardbackward
• levelstring可选

  query: Minimum log level to return.

  取值 debuginfowarnerror
• searchstring可选

  query: Case-sensitive substring filter on log messages.

Returns

200

Errors follow the E2B format — see error codes