> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# E2B

> How to set up the E2B connector, plus the actions and events that are available.

![E2B](https://stackone-logos.com/api/e2b/filled/svg)

v1.2.4[See changelog](https://docs.stackone.com/connectors/e2b/changelog.md)

[62 actions](#actions) · [6 events](#events) · 1 auth method

Developer Tools

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/e2b/guides/connector-profile/api-key.md)
>
> Uses a team API key. The key is team-scoped, so it reaches only the sandboxes, templates, volumes and secrets belonging...

Optionally, configure receiving Events for E2B into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/e2b/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/e2b/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

62 actions

ActionDescription

List Directory`e2b_list_directory`

List the entries of a directory inside a running sandbox, optionally recursing to a given depth.

Stat File`e2b_stat_file`

Return metadata for one path inside a running sandbox.

Upload File`e2b_upload_file`

Upload a file into a running sandbox, creating parent directories as needed.

Download File`e2b_download_file`

Download a file from inside a running sandbox by path.

Make Directory`e2b_make_directory`

Create a directory inside a running sandbox.

Move File`e2b_move_file`

Move or rename a file or directory inside a running sandbox.

Remove File`e2b_remove_file`

Delete a file or directory inside a running sandbox.

Create Watcher`e2b_create_watcher`

Create a pollable filesystem watcher on a directory inside a running sandbox.

Get Watcher Events`e2b_get_watcher_events`

Drain the filesystem events a watcher has buffered since the last poll.

Remove Watcher`e2b_remove_watcher`

Destroy a filesystem watcher and free its server-side event buffer.

Compose Files`e2b_compose_files`

Concatenate several files inside a sandbox into one using zero-copy composition.

List Processes`e2b_list_processes`

List the processes currently running inside a sandbox.

Send Process Input`e2b_send_process_input`

Send stdin or PTY bytes to a running process inside a sandbox.

Send Process Signal`e2b_send_process_signal`

Send a termination signal to a running process inside a sandbox.

Update Process`e2b_update_process`

Update a running process inside a sandbox, such as resizing its pseudo-terminal.

Close Process Stdin`e2b_close_process_stdin`

Close standard input on a running process to signal end of file.

Get Sandbox Health`e2b_get_sandbox_health`

Probe whether a sandbox's in-sandbox agent is alive and reachable.

Get Sandbox Service Stats`e2b_get_sandbox_service_stats`

Return internal service statistics from a sandbox's in-sandbox agent.

List Sandbox Environment Variables`e2b_list_sandbox_env_vars`

Return the environment variables visible inside a running sandbox.

List Sandboxes`e2b_list_sandboxes`

List the team's sandboxes, newest first, with optional state, template, metadata and start-time filters.

Get Sandbox`e2b_get_sandbox`

Get a single sandbox by ID, including its state, resource allocation, expiry and envd access token.

Create Sandbox`e2b_create_sandbox`

Start a new sandbox from a template and return its ID and envd access token.

Connect To Sandbox`e2b_connect_sandbox`

Return sandbox details and resume the sandbox first if it is paused.

Pause Sandbox`e2b_pause_sandbox`

Snapshot a sandbox in place and stop it so it can be resumed later.

Kill Sandbox`e2b_kill_sandbox`

Terminate a sandbox immediately and release its resources.

Fork Sandbox`e2b_fork_sandbox`

Checkpoint a running sandbox and create new sandboxes from that snapshot.

Set Sandbox Timeout`e2b_set_sandbox_timeout`

Overwrite a sandbox's time to live so it expires the given number of seconds from now.

Refresh Sandbox`e2b_refresh_sandbox`

Extend a sandbox's time to live to keep it alive.

Update Sandbox Network`e2b_update_sandbox_network`

Replace the egress network rules on a running sandbox.

Get Sandbox Logs`e2b_get_sandbox_logs`

Read a sandbox's log stream with cursor, direction, level and search filters.

Get Sandbox Metrics`e2b_get_sandbox_metrics`

Return the CPU, memory and disk time series for one sandbox.

List Sandbox Metrics`e2b_list_sandbox_metrics`

Return metrics for several sandboxes in a single call.

Create Snapshot`e2b_create_snapshot`

Capture a sandbox's current state as a persistent snapshot that outlives the sandbox.

List Snapshots`e2b_list_snapshots`

List the team's snapshots, optionally filtered by source sandbox or name.

List Secrets`e2b_list_secrets`

List the project's secrets, returning metadata only.

Get Secret`e2b_get_secret`

Get one secret's metadata by identifier or name.

Create Secret`e2b_create_secret`

Create a secret by storing a runtime marker as its first version.

Update Secret`e2b_update_secret`

Rotate a secret by appending a new version of its stored marker.

Delete Secret`e2b_delete_secret`

Revoke a secret and schedule its versions for cleanup.

List Template Tags`e2b_list_template_tags`

List all tags pointing at builds of one template.

Assign Tags`e2b_assign_tags`

Assign one or more tags to a template build.

Delete Tags`e2b_delete_tags`

Delete one or more tags from a template.

Get Team Metrics`e2b_get_team_metrics`

Return the team's concurrent-sandbox and sandbox-start-rate time series over an interval.

Get Team Metrics Max`e2b_get_team_metrics_max`

Return the peak value of one team metric over an interval.

List Templates`e2b_list_templates`

List the team's template definitions.

Check Template Alias`e2b_check_template_alias`

Check whether a template exists under a given alias.

List Template Builds`e2b_list_template_builds`

List all builds for one template.

Create Template`e2b_create_template`

Create a new sandbox template and its initial build record.

Update Template`e2b_update_template`

Update a template's settings, such as whether it is public.

Delete Template`e2b_delete_template`

Delete a template and its builds.

Get Build Upload Link`e2b_get_build_upload_link`

Get a presigned upload link for a tar file of template build layer files.

Start Build`e2b_start_build`

Start building a template image from a base image or template and a list of steps.

Get Build Status`e2b_get_build_status`

Get the status of one template build, with a slice of its logs.

Get Build Logs`e2b_get_build_logs`

Read a template build's log stream with cursor, direction, level and source filters.

List Volumes`e2b_list_volumes`

List the team's persistent volumes.

Get Volume`e2b_get_volume`

Get one persistent volume by ID.

Create Volume`e2b_create_volume`

Create a new persistent volume for the team.

Delete Volume`e2b_delete_volume`

Delete a persistent volume from the team.

List Webhooks`e2b_list_webhooks`

List every webhook registered for the API key's team.

Get Webhook`e2b_get_webhook`

Return the configuration of a single registered webhook.

List Webhook Deliveries`e2b_list_webhook_deliveries`

List the delivery attempts a webhook has made, newest first, with optional time, status and event-type filters.

Get Webhook Statistics`e2b_get_webhook_statistics`

Return aggregate delivery counts and latency for a webhook over an interval.

## Events

Tags

Select all
|
Clear

Sandboxes

Webhooks

No tags found

6 events

EventDescriptionTags

Sandbox Created`e2b_webhook_sandbox_created`

Processes events fired when a sandbox is created.

SandboxesWebhooks

Sandbox Killed`e2b_webhook_sandbox_killed`

Processes events fired when a running sandbox is terminated.

SandboxesWebhooks

Sandbox Paused`e2b_webhook_sandbox_paused`

Processes events fired when a sandbox is paused.

SandboxesWebhooks

Sandbox Resumed`e2b_webhook_sandbox_resumed`

Processes events fired when a paused sandbox is resumed.

SandboxesWebhooks

Sandbox Updated`e2b_webhook_sandbox_updated`

Processes events fired when a sandbox's configuration changes.

SandboxesWebhooks

Sandbox Checkpointed`e2b_webhook_sandbox_checkpointed`

Processes events fired when a sandbox snapshot is created.

SandboxesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.