E2e2b-dev
sandboxes

List sandboxes (v2)

Changed on

List all sandboxes

get/v2/sandboxes

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/v2/sandboxes
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer and API key in header X-Team-ID
    • or API key in header X-Admin-Token and API key in header X-Team-ID
    • or HTTP bearer and API key in header X-Team-ID

Query parameters

metadatastring

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

stateSandboxState[]

Filter sandboxes by one or more states

order'asc' | 'desc'

Sort direction

Sort direction by sandbox start time. Defaults to desc (newest first).

startedAfterstring date-time

Return sandboxes started at or after this timestamp.

templatestring

Filter sandboxes by a template ID or alias.

nextTokenstring

Cursor to start the list from

limitinteger

Maximum number of items to return per page

Response

Successfully returned all running sandboxes

templateIDstring required

Identifier of the template from which is the sandbox created

aliasstring

Alias of the template

sandboxIDstring required

Identifier of the sandbox

clientIDstring required

Identifier of the client

startedAtstring date-time required

Time when the sandbox was started

endAtstring date-time required

Time when the sandbox will expire

cpuCountinteger required

CPU cores for the sandbox

memoryMBinteger required

Memory for the sandbox in MiB

diskSizeMBinteger required

Disk size for the sandbox in MiB

metadataunknown
state'running' | 'paused' required

State of the sandbox

envdVersionstring required

Version of the envd running in the sandbox

Changes