Skip to main content
GET
/
v2
/
sandboxes
cURL
curl --request GET \
  --url https://api.e2b.app/v2/sandboxes \
  --header 'X-API-Key: <api-key>'
[
  {
    "templateID": "<string>",
    "sandboxID": "<string>",
    "clientID": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "cpuCount": 2,
    "memoryMB": 129,
    "diskSizeMB": 1,
    "state": "running",
    "envdVersion": "<string>",
    "alias": "<string>",
    "metadata": {}
  }
]

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
metadata
string

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

​
state
enum<string>[]

Filter sandboxes by one or more states

State of the sandbox

Available options:
running,
paused
​
nextToken
string

Cursor to start the list from

​
limit
integer<int32>
default:100

Maximum number of items to return per page

Required range: 1 <= x <= 100

Response

Successfully returned all running sandboxes

​
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

​
startedAt
string<date-time>
required

Time when the sandbox was started

​
endAt
string<date-time>
required

Time when the sandbox will expire

​
cpuCount
integer<int32>
required

CPU cores for the sandbox

Required range: x >= 1
​
memoryMB
integer<int32>
required

Memory for the sandbox in MiB

Required range: x >= 128
​
diskSizeMB
integer<int32>
required

Disk size for the sandbox in MiB

Required range: x >= 0
​
state
enum<string>
required

State of the sandbox

Available options:
running,
paused
​
envdVersion
string
required

Version of the envd running in the sandbox

​
alias
string

Alias of the template

​
metadata
object