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 — 12 operation(s) for sandboxes.

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

Tagged areas include Sandboxes. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 15 operations across 12 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

15 operations 12 paths 4 schemas 1 DELETE7 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.e2b.dev
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

E2B Sandboxes API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (E2BApiKey). By default, every request must be authenticated.

Paths & Operations 15

Across 12 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 sandboxes
listSandboxes 1 param → 200401
POST
/sandboxes
Create a sandbox
createSandbox body → 201401
GET
/sandboxes/{sandboxID}
Get sandbox
getSandbox 1 param → 200
DELETE
/sandboxes/{sandboxID}
Terminate a sandbox
deleteSandbox 1 param → 204
POST
/sandboxes/{sandboxID}/pause
Pause a sandbox
pauseSandbox 1 param → 200
POST
/sandboxes/{sandboxID}/resume
Resume a paused sandbox
resumeSandbox 1 param → 200
POST
/sandboxes/{sandboxID}/timeout
Set sandbox timeout
setSandboxTimeout 1 param body → 200
GET
/sandboxes/{sandboxID}/logs
Get sandbox logs
getSandboxLogs 1 param → 200
GET
/sandboxes/{sandboxID}/metrics
Get sandbox metrics
getSandboxMetrics 1 param → 200
POST
/sandboxes/{sandboxID}/files/upload
Upload a file into the sandbox
uploadFile 2 params body → 200
GET
/sandboxes/{sandboxID}/files/download
Download a file from the sandbox
downloadFile 2 params → 200
GET
/sandboxes/{sandboxID}/files/list
List files in a sandbox directory
listFiles 2 params → 200
POST
/sandboxes/{sandboxID}/processes
Start a process inside the sandbox
startProcess 1 param body → 200
GET
/sandboxes/{sandboxID}/processes
List processes in the sandbox
listProcesses 1 param → 200
POST
/sandboxes/{sandboxID}/processes/{processID}/signal
Send a signal to a sandbox process
signalProcess 2 params body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Sandbox (12 properties), FileEntry (4 properties), Process (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Process
object
3 properties
Sandbox
object
12 properties
FileEntry
object
4 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

e2b-sandboxes-api-openapi.yml Raw ↑

Other APIs E2B publishes across the network.

E2B Sandbox API
E2B Templates API