Documentation

List sandboxes

You can list sandboxes using the Sandbox.list() method.

Once you have information about running sandbox, you can connect to it using the Sandbox.connect() method.

import { Sandbox } from '@e2b/code-interpreter'

// Create a sandbox.
const sandbox = await Sandbox.create({
  metadata: {
    name: 'My Sandbox',
  },
})

// List all running sandboxes.
const runningSandboxes = await Sandbox.list() 
const runningSandbox = runningSandboxes[0]

console.log('Running sandbox metadata:', runningSandbox.metadata)
console.log('Running sandbox id:', runningSandbox.sandboxId)
console.log('Running sandbox started at:', runningSandbox.startedAt)
console.log('Running sandbox template id:', runningSandbox.templateId)

The code above will output something like this:

Terminal
Running sandbox metadata: {
  name: "My Sandbox",
}
Running sandbox id: ixjj3iankaishgcge4jwn-b0b684e9
Running sandbox started at: 2024-10-15T21:13:07.311Z
Running sandbox template id: 3e4rngfa34txe0gxc1zf

Filtering sandboxes

You can filter sandboxes by specifying Metadata key value pairs. Specifying multiple key value pairs will return sandboxes that match all of them.

This can be useful when you have a large number of sandboxes and want to find only specific ones. The filtering is performed on the server.

import { Sandbox } from '@e2b/code-interpreter'

// Create sandbox with metadata.
const sandbox = await Sandbox.create({
  metadata: {
    env: 'dev', 
    app: 'my-app', 
    userId: '123', 
  },
})

// List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`.
const runningSandboxes = await Sandbox.list({
  query: {
    metadata: { userId: '123', env: 'dev' }, 
  },
})

Changes in the Beta SDKs

If you're using the beta version of the SDK, the Sandbox.list() method was updated.

Listing sandboxes

The Sandbox.list() method now supports pagination. In the advanced pagination section, you can find more information about pagination techniques using the updated method.

import { Sandbox, SandboxInfo } from '@e2b/code-interpreter'

const sandbox = await Sandbox.create()

const paginator = Sandbox.list() 

// Get the first page of sandboxes (running and paused)
const firstPage = await paginator.nextItems() 

// Get the next page of sandboxes
const nextPage = await paginator.nextItems()

Filtering sandboxes

Filter sandboxes by their current state. The state parameter can contain either "running" for running sandboxes or "paused" for paused sandboxes, or both.

import { Sandbox } from '@e2b/code-interpreter'

// Create a sandbox.
const sandbox = await Sandbox.create()

// List all sandboxes that are running or paused.
const paginator = Sandbox.list({
  query: {
    state: ['running', 'paused'], 
  },
})

const sandboxes = await paginator.nextItems()

Filter sandboxes by the metadata key value pairs specified during Sandbox creation.

import { Sandbox } from '@e2b/code-interpreter'

// Create sandbox with metadata.
const sandbox = await Sandbox.create({
  metadata: {
    env: 'dev', 
    app: 'my-app', 
    userId: '123', 
  },
})

// List all sandboxes that has `userId` key with value `123` and `env` key with value `dev`.
const paginator = Sandbox.list({
  query: {
    metadata: { userId: '123', env: 'dev' }, 
  },
})

const sandboxes = await paginator.nextItems()

Advanced pagination

For more granular pagination, you can set custom per-page item limit (default and maximum is 1000) and specify an offset parameter (nextToken or next_token) to start paginating from.

import { Sandbox } from '@e2b/code-interpreter'

const paginator = Sandbox.list({
  limit: 1000, 
  nextToken: '<base64-encoded-token>', 
})

// Additional paginator properties
// Whether there is a next page
paginator.hasNext

// Next page token
paginator.nextToken

// Fetch the next page
await paginator.nextItems()

You can fetch all pages by looping through the paginator while checking if there is a next page (using hasNext or has_next property) and fetching until there are no more pages left to fetch:

import { Sandbox } from '@e2b/code-interpreter'

const paginator = Sandbox.list()

// Loop through all pages
const sandboxes: SandboxInfo[] = []
while (paginator.hasNext) { 
  const items = await paginator.nextItems()
  sandboxes.push(...items)
}