请求体

• templateIDstring必填

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

• timeoutinteger可选
  默认 300

  Lifetime of the new sandbox in seconds. Defaults to 300 seconds when omitted.

• autoPauseboolean可选
  默认 false

  Automatically pauses the sandbox after the timeout

• metadataany可选

  Your own string key/value pairs stored with the sandbox; usable as a filter in listSandboxes.

• envVarsany可选

  Environment variables as name to value string pairs.

• 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可选

  Network policy of the sandbox: public access, egress allow and deny lists and proxy.

  ▸ 展开子字段（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可选

    Volumes to mount into the sandbox, each with the volume name and the path inside the sandbox.

    ▸ 展开子字段（2）

    • namestring必填

      Name of the volume

    • pathstring必填

      Path of the volume

返回

201

平台暂未提供 E2B 默认的 base 模板：不带模板参数的 Sandbox.create() 会返回 404，请显式指定模板（可用模板见「列出模板」）。

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• templateIDstring可选
  默认 "base"

  目标模板，默认 base（node22 别名）；必须包含 E2B 镜像，否则返回 INVALID_PARAMS。升级期间文件、进程与数据面操作返回 409。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• 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: live：运行中；exited：已退出；all：全部保留记录。默认 live。

• 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

• namestring可选

  query: 按名称子串搜索，不区分大小写；中文、%、_ 和反斜杠按原样匹配。去除首尾空白后须为 1–64 个字符。可与状态及分页参数组合；历史空名称不匹配。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• namestring必填

  新名称；去除首尾空白后须为 1–64 个字符。同团队重名返回 409。请求只允许 name 字段。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• startinteger可选

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

• endinteger可选

  query: Unix timestamp in seconds at which the metrics window ends. Omit it to read up to the latest sample.

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• timeoutinteger必填

  New lifetime in seconds from now, replacing the current expiry rather than adding to it. May shorten the remaining lifetime.

返回

204

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

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

返回

204

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• timeoutinteger可选
  默认 300

  Requested remaining lifetime in seconds from the connection. Defaults to 300 seconds; an existing later expiry is preserved.

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

返回

201

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

返回

204

错误按 E2B 格式返回，参见 错误码

请求参数

• teamIDstring可选

  query: Id of the team whose templates to list. Omit it to list the templates of your own team; a team you do not belong to answers 403.

• nextTokenstring可选

  query: Cursor to start the list from

• limitinteger可选
  默认 100

  query: Maximum number of items to return per page

返回

200

错误按 E2B 格式返回，参见 错误码

请求体

• namestring必填

  Volume name, unique within your team. Use one or more ASCII letters, digits, underscores or hyphens.

返回

201

错误按 E2B 格式返回，参见 错误码

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• volumeIDstring必填

  path: Id of the team volume, the `volumeID` returned by createVolume or listVolumes.

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• volumeIDstring必填

  path: Id of the team volume, the `volumeID` returned by createVolume or listVolumes.

返回

204

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• timeoutinteger可选
  默认 15

  新副本的存活时间，单位为秒。

• countinteger可选
  默认 1

  要创建的独立副本数。所有副本来自同一次快照，每个副本分别返回成功结果或错误。

返回

201

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• namestring可选

  可选别名。同一主体重复使用该别名会更新既有快照，保留本平台快照 ID。

返回

201

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring可选

  query: 按来源沙箱 ID 筛选。

• namestring可选

  query: 按原始别名或本平台 snap_ 快照 ID 筛选。

• limitinteger可选
  默认 100

  query: 每页返回的快照数量上限。

• nextTokenstring可选

  query: 上一页响应头 X-Next-Token 返回的游标。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• snapshotIDstring必填

  path: 本平台返回的 snap_ 快照 ID。

返回

204

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• allow_internet_accessboolean可选

  是否允许访问外网。false 等效于 denyOut 包含 0.0.0.0/0。

• allowOutarray可选

  出站目标白名单，可用 CIDR、IP 或域名；白名单优先于拒绝规则。

• denyOutarray可选

  出站目标黑名单，支持 CIDR 或 IP，不支持域名。

• egressProxyobject可选

  上游代理配置字段，当前平台尚未应用。

  ▸ 展开子字段（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可选

  上游按域名转换规则字段，当前平台尚未应用。

返回

204

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• cursorinteger可选

  query: 起始时间戳，单位为 Unix 毫秒。

• limitinteger可选
  默认 1000

  query: 最多返回的日志条数。

• directionstring可选

  query: forward 按时间向后读取；backward 按时间向前读取。

  取值 forwardbackward
• levelstring可选

  query: 最低日志级别，低于该级别的日志会被过滤。

  取值 debuginfowarnerror
• searchstring可选

  query: 按日志正文的子串筛选，区分大小写。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• timeoutnumber必填

  从当前时刻起计算的有效秒数：900、1800 或 3600。必须延长现有截止时间。

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• statestring可选

  query: live：运行中；exited：已退出；all：全部保留记录。默认 live。

  取值 liveexitedall

返回

200

错误按 E2B 格式返回，参见 错误码

请求参数

• sandboxIDstring必填

  path: 沙箱 ID。

• processIDstring必填

  path: 从进程列表取得的 processId。

返回

200

错误按 E2B 格式返回，参见 错误码