List running sandboxes

GET /sandbox/v1/sandboxes● Supported

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: live: running; exited: finished; all: all retained observations. Defaults to 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: Case-insensitive literal name substring, 1–64 characters after trimming. Chinese, %, _ and backslash match literally. Combines with filters and pagination; historical NULL names do not match.

200

Errors follow the E2B format — see error codes

Successfully returned all running sandboxes

application/json

Name	Type	Description
[].templateID	string	Identifier of the template from which is the sandbox created
[].alias	string	Alias of the template
[].sandboxID	string	Identifier of the sandbox
[].clientID	string	Identifier of the client
[].startedAt	string	Time when the sandbox was started
[].endAt	string	Time when the sandbox will expire
[].cpuCount	integer	CPU cores for the sandbox
[].memoryMB	integer	Memory for the sandbox in MiB
[].diskSizeMB	integer	Disk size for the sandbox in MiB
[].metadata	any	Your own string key/value pairs stored with the sandbox; usable as a filter in listSandboxes.
[].state	string	State of the sandbox
[].envdVersion	string	Version of the envd running in the sandbox
[].volumeMounts	array<object>	Volumes mounted into the sandbox.
[].volumeMounts[].name	string	Name of the volume
[].volumeMounts[].path	string	Path of the volume