Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

E2B sandboxes API

The sandboxes API from E2B — 13 operation(s) for sandboxes.

E2B sandboxes API is one of 14 APIs that E2B publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include sandboxes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 15 operations across 13 paths, and defines 30 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against a single base URL, https://api.e2b.app.

15 operations 13 paths 30 schemas 1 DELETE7 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://api.e2b.app
Authentication
API Key, HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

E2B sandboxes API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP bearer tokens (access_token) (AccessTokenAuth). An API key is passed in the header as X-Supabase-Token (Supabase1TokenAuth). An API key is passed in the header as X-Supabase-Team (Supabase2TeamAuth). An API key is passed in the header as X-Admin-Token (AdminTokenAuth).

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 7 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

sandboxes 15
GET
/sandboxes
List all running sandboxes
1 param → 200401400500
POST
/sandboxes
Create a sandbox from the template
body → 201401400500
GET
/v2/sandboxes
List all sandboxes
4 params → 200401400500
GET
/sandboxes/metrics
List metrics for given sandboxes
1 param → 200401400500
GET
/sandboxes/{sandboxID}/logsdeprecated
Get sandbox logs. Use /v2/sandboxes/{sandboxID}/logs instead.
3 params → 200404401500
GET
/v2/sandboxes/{sandboxID}/logs
Get sandbox logs
6 params → 200401404500
GET
/sandboxes/{sandboxID}
Get a sandbox by id
1 param → 200404401500
DELETE
/sandboxes/{sandboxID}
Kill a sandbox
1 param → 204404401500
GET
/sandboxes/{sandboxID}/metrics
Get sandbox metrics
3 params → 200400401404500
POST
/sandboxes/{sandboxID}/pause
Pause the sandbox
1 param → 204409404401500
POST
/sandboxes/{sandboxID}/resumedeprecated
Resume the sandbox
1 param body → 201409404401500
POST
/sandboxes/{sandboxID}/connect
Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended.
1 param body → 200201400401404500
POST
/sandboxes/{sandboxID}/timeout
Set the timeout for the sandbox. The sandbox will expire x seconds from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the st…
1 param body → 204401404500
POST
/sandboxes/{sandboxID}/refreshes
Refresh the sandbox extending its time to live
1 param body → 204401404
POST
/sandboxes/{sandboxID}/snapshots
Create a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime.
1 param body → 201400401404500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are SandboxDetail (18 properties), ListedSandbox (13 properties), NewSandbox (11 properties), Sandbox (8 properties). Each schema is shown below with its type and property counts.

SandboxLog
object
Log entry with timestamp and line
2 properties 2 required
SandboxAutoResumeEnabled
boolean
Auto-resume enabled flag for paused sandboxes. Default false.
SandboxAutoResumeConfig
object
Auto-resume configuration for paused sandboxes.
1 property 1 required
ListedSandbox
object
13 properties 10 required
Sandbox
object
8 properties 4 required
DiskSizeMB
integer
Disk size for the sandbox in MiB
ResumedSandbox
object
2 properties
ConnectSandbox
object
1 property 1 required
SandboxMetric
object
Metric entry with timestamp and line
8 properties 8 required
EnvVars
SandboxVolumeMount
object
2 properties 2 required
SandboxMetadata
SandboxLogsV2Response
object
1 property 1 required
Error
object
2 properties 2 required
NewSandbox
object
11 properties 1 required
SandboxLifecycle
object
Sandbox lifecycle policy returned by sandbox info.
2 properties 2 required
LogLevel
string
State of the sandbox
CPUCount
integer
CPU cores for the sandbox
SandboxDetail
object
18 properties 10 required
SandboxOnTimeout
string
Action taken when the sandbox times out.
MemoryMB
integer
Memory for the sandbox in MiB
EnvdVersion
string
Version of the envd running in the sandbox
SandboxState
string
State of the sandbox
SandboxesWithMetrics
object
1 property 1 required
SandboxNetworkConfig
object
4 properties
SnapshotInfo
object
2 properties 2 required
SandboxLogs
object
2 properties 2 required
LogsDirection
string
Direction of the logs that should be returned
Mcp
object
MCP configuration for the sandbox
SandboxLogEntry
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

e2b-dev-sandboxes-api-openapi.yml Raw ↑

Other APIs E2B publishes across the network.

E2B Code Interpreter SDK
E2B Desktop Sandbox SDK
E2B access-tokens API
E2B admin API
E2B api-keys API
E2B auth API
E2B events API
E2B Health API
E2B snapshots API
E2B tags API
E2B templates API
E2B volumes API