### Start build (v2) Source: https://e2b.dev/docs/llms.txt Starts the build process for a template. This is the latest version for starting builds. ```APIDOC ## POST /v2/templates/{templateID}/start-build ### Description Start the build. ### Method POST ### Endpoint /v2/templates/{templateID}/start-build ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template to start the build for. ``` -------------------------------- ### Start Source: https://e2b.dev/docs/llms.txt Starts a new process within the E2B sandbox. This is a server-streaming RPC. ```APIDOC ## POST /v1/proc/start ### Description Server-streaming RPC. Use the Connect protocol with streaming support. ### Method POST ### Endpoint /v1/proc/start ``` -------------------------------- ### WatchDir Source: https://e2b.dev/docs/llms.txt Starts watching a directory for changes. This is a server-streaming RPC. ```APIDOC ## POST /v1/fs/watch ### Description Server-streaming RPC. Use the Connect protocol with streaming support. ### Method POST ### Endpoint /v1/fs/watch ``` -------------------------------- ### Get volumes Source: https://e2b.dev/docs/llms.txt Lists all team volumes. ```APIDOC ## GET /volumes ### Description List all team volumes. ### Method GET ### Endpoint /volumes ``` -------------------------------- ### Get template builds Source: https://e2b.dev/docs/llms.txt Lists all builds associated with a specific template. ```APIDOC ## GET /templates/{templateID}/builds ### Description List all builds for a template. ### Method GET ### Endpoint /templates/{templateID}/builds ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template to list builds for. ``` -------------------------------- ### Get snapshots Source: https://e2b.dev/docs/llms.txt Lists all snapshots associated with the team. ```APIDOC ## GET /snapshots ### Description List all snapshots for the team. ### Method GET ### Endpoint /snapshots ``` -------------------------------- ### Get build logs Source: https://e2b.dev/docs/llms.txt Retrieves the build logs for a specific template build. ```APIDOC ## GET /templates/{templateID}/builds/{buildID}/logs ### Description Get template build logs. ### Method GET ### Endpoint /templates/{templateID}/builds/{buildID}/logs ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template. - **buildID** (string) - Required - The ID of the build. ``` -------------------------------- ### Get build upload link Source: https://e2b.dev/docs/llms.txt Provides an upload URL for a tar file containing build layer files for a template build. ```APIDOC ## GET /templates/{templateID}/builds/{buildID}/upload-link ### Description Get an upload link for a tar file containing build layer files. ### Method GET ### Endpoint /templates/{templateID}/builds/{buildID}/upload-link ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template. - **buildID** (string) - Required - The ID of the build. ``` -------------------------------- ### Get sandbox Source: https://e2b.dev/docs/llms.txt Retrieves details for a specific sandbox instance using its ID. ```APIDOC ## GET /v1/sandboxes/{sandbox_id} ### Description Gets a sandbox by id. ### Method GET ### Endpoint /v1/sandboxes/{sandbox_id} ``` -------------------------------- ### Get sandbox metrics Source: https://e2b.dev/docs/llms.txt Retrieves metrics for a specific sandbox. ```APIDOC ## GET /sandboxes/{sandboxID}/metrics ### Description Get sandbox metrics. ### Method GET ### Endpoint /sandboxes/{sandboxID}/metrics ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox for which to retrieve metrics. ``` -------------------------------- ### Get build status Source: https://e2b.dev/docs/llms.txt Retrieves the build status and information for a template build. ```APIDOC ## GET /templates/{templateID}/builds/{buildID}/status ### Description Get template build info. ### Method GET ### Endpoint /templates/{templateID}/builds/{buildID}/status ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template. - **buildID** (string) - Required - The ID of the build. ``` -------------------------------- ### Get the environment variables Source: https://e2b.dev/docs/llms.txt Retrieves the environment variables configured for the E2B service. ```APIDOC ## GET /envd/env ### Description Gets the environment variables of the E2B service. ### Method GET ### Endpoint /envd/env ``` -------------------------------- ### Get template by alias Source: https://e2b.dev/docs/llms.txt Checks if a template with the specified alias exists. ```APIDOC ## GET /templates/alias/{alias} ### Description Check if template with given alias exists. ### Method GET ### Endpoint /templates/alias/{alias} ### Parameters #### Path Parameters - **alias** (string) - Required - The alias of the template to check. ``` -------------------------------- ### Get team metrics Source: https://e2b.dev/docs/llms.txt Retrieves metrics for the team. ```APIDOC ## GET /teams/metrics ### Description Get metrics for the team. ### Method GET ### Endpoint /teams/metrics ``` -------------------------------- ### Get the stats of the service Source: https://e2b.dev/docs/llms.txt Retrieves performance statistics for the E2B service. ```APIDOC ## GET /envd/stats ### Description Gets the stats of the E2B service. ### Method GET ### Endpoint /envd/stats ``` -------------------------------- ### Get sandbox logs (v2) Source: https://e2b.dev/docs/llms.txt Retrieves logs for a specific sandbox. This is the recommended endpoint for accessing sandbox logs. ```APIDOC ## GET /v2/sandboxes/{sandboxID}/logs ### Description Get sandbox logs. ### Method GET ### Endpoint /v2/sandboxes/{sandboxID}/logs ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox to retrieve logs from. ``` -------------------------------- ### Get team metrics max Source: https://e2b.dev/docs/llms.txt Retrieves the maximum metrics for the team within a specified interval. ```APIDOC ## GET /teams/metrics/max ### Description Get the maximum metrics for the team in the given interval. ### Method GET ### Endpoint /teams/metrics/max ### Parameters #### Query Parameters - **from** (string) - Required - The start of the interval (ISO 8601 format). - **to** (string) - Required - The end of the interval (ISO 8601 format). ``` -------------------------------- ### Set sandbox timeout Source: https://e2b.dev/docs/llms.txt Sets the timeout for the sandbox. The sandbox will expire a specified duration from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the starting point to measure the timeout duration. ```APIDOC ## POST /sandboxes/{sandboxID}/set-timeout ### Description Set the timeout for the sandbox. The sandbox will expire x seconds from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the starting point to measure the timeout duration. ### Method POST ### Endpoint /sandboxes/{sandboxID}/set-timeout ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox to set the timeout for. #### Query Parameters - **seconds** (integer) - Required - The number of seconds from now until the sandbox expires. ``` -------------------------------- ### Connect Source: https://e2b.dev/docs/llms.txt Establishes a connection to a process. This is a server-streaming RPC. ```APIDOC ## POST /v1/proc/connect ### Description Server-streaming RPC. Use the Connect protocol with streaming support. ### Method POST ### Endpoint /v1/proc/connect ``` -------------------------------- ### List Source: https://e2b.dev/docs/llms.txt Lists running processes within the E2B sandbox. ```APIDOC ## GET /v1/proc/list ### Description Lists running processes. ### Method GET ### Endpoint /v1/proc/list ``` -------------------------------- ### Create sandbox Source: https://e2b.dev/docs/llms.txt Creates a new sandbox instance based on a specified template. ```APIDOC ## POST /v1/sandboxes ### Description Creates a sandbox from the template. ### Method POST ### Endpoint /v1/sandboxes ``` -------------------------------- ### MakeDir Source: https://e2b.dev/docs/llms.txt Creates a new directory within the E2B sandbox. ```APIDOC ## POST /v1/fs/dirs ### Description Creates a new directory. ### Method POST ### Endpoint /v1/fs/dirs ``` -------------------------------- ### List sandboxes (v2) Source: https://e2b.dev/docs/llms.txt Lists all sandboxes for the team. This is the recommended endpoint for listing sandboxes. ```APIDOC ## GET /v2/sandboxes ### Description List all sandboxes. ### Method GET ### Endpoint /v2/sandboxes ``` -------------------------------- ### List templates Source: https://e2b.dev/docs/llms.txt Lists all available templates. ```APIDOC ## GET /templates ### Description List all templates. ### Method GET ### Endpoint /templates ``` -------------------------------- ### Connect to sandbox Source: https://e2b.dev/docs/llms.txt Connects to an existing sandbox, resuming it if it's paused. The Time-To-Live (TTL) is extended upon connection. ```APIDOC ## POST /v1/sandboxes/connect ### Description Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. ### Method POST ### Endpoint /v1/sandboxes/connect ``` -------------------------------- ### List sandbox metrics Source: https://e2b.dev/docs/llms.txt Lists metrics for given sandboxes. ```APIDOC ## GET /sandboxes/metrics ### Description List metrics for given sandboxes. ### Method GET ### Endpoint /sandboxes/metrics ### Parameters #### Query Parameters - **sandboxIDs** (string[]) - Required - A list of sandbox IDs to retrieve metrics for. ``` -------------------------------- ### Upload a file Source: https://e2b.dev/docs/llms.txt Uploads a file to the E2B sandbox and ensures parent directories exist. Overwrites if the file exists. Metadata can be provided via `X-Metadata-: ` headers. ```APIDOC ## POST /v1/fs/upload ### Description Uploads a file and ensures the parent directories exist. If the file exists, it will be overwritten. Any request header of the form `X-Metadata-: ` is persisted as a user-defined extended attribute on the uploaded file. ### Method POST ### Endpoint /v1/fs/upload ``` -------------------------------- ### CreateWatcher Source: https://e2b.dev/docs/llms.txt Creates a file system watcher. This is a non-streaming version of WatchDir. ```APIDOC ## POST /v1/fs/watchers ### Description Non-streaming versions of WatchDir. ### Method POST ### Endpoint /v1/fs/watchers ``` -------------------------------- ### Resume sandbox Source: https://e2b.dev/docs/llms.txt Resumes the specified sandbox, allowing it to continue execution. ```APIDOC ## POST /sandboxes/{sandboxID}/resume ### Description Resume the sandbox. ### Method POST ### Endpoint /sandboxes/{sandboxID}/resume ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox to resume. ``` -------------------------------- ### Create snapshot Source: https://e2b.dev/docs/llms.txt Creates a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime. ```APIDOC ## POST /sandboxes/{sandboxID}/snapshots ### Description Create a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime. ### Method POST ### Endpoint /sandboxes/{sandboxID}/snapshots ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox to create a snapshot from. ``` -------------------------------- ### Download a file Source: https://e2b.dev/docs/llms.txt Downloads a file from the E2B sandbox. ```APIDOC ## GET /v1/fs/download ### Description Downloads a file from the E2B sandbox. ### Method GET ### Endpoint /v1/fs/download ``` -------------------------------- ### Create template (v3) Source: https://e2b.dev/docs/llms.txt Creates a new template. This is the latest version for template creation. ```APIDOC ## POST /v3/templates ### Description Create a new template. ### Method POST ### Endpoint /v3/templates ### Parameters #### Request Body - **name** (string) - Required - The name of the template. - **description** (string) - Optional - A description for the template. - **pkg** (string) - Optional - The package name for the template. ``` -------------------------------- ### SendInput Source: https://e2b.dev/docs/llms.txt Sends input data to a process. ```APIDOC ## POST /v1/proc/sendinput ### Description Sends input data to a process. ### Method POST ### Endpoint /v1/proc/sendinput ``` -------------------------------- ### Assign tags Source: https://e2b.dev/docs/llms.txt Assigns one or more tags to a template build. ```APIDOC ## POST /tags/assign ### Description Assign tag(s) to a template build. ### Method POST ### Endpoint /tags/assign ### Parameters #### Request Body - **templateBuildID** (string) - Required - The ID of the template build to assign tags to. - **tags** (string[]) - Required - A list of tags to assign. ``` -------------------------------- ### ListDir Source: https://e2b.dev/docs/llms.txt Lists the contents of a directory within the E2B sandbox. ```APIDOC ## GET /v1/fs/list ### Description Lists the contents of a directory. ### Method GET ### Endpoint /v1/fs/list ``` -------------------------------- ### Move Source: https://e2b.dev/docs/llms.txt Moves a file or directory within the E2B sandbox. ```APIDOC ## POST /v1/fs/move ### Description Moves a file or directory. ### Method POST ### Endpoint /v1/fs/move ``` -------------------------------- ### Rebuild template Source: https://e2b.dev/docs/llms.txt Initiates a rebuild process for a specified template. ```APIDOC ## POST /templates/{templateID}/rebuild ### Description Rebuild an template. ### Method POST ### Endpoint /templates/{templateID}/rebuild ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template to rebuild. ``` -------------------------------- ### Update Source: https://e2b.dev/docs/llms.txt Updates an existing process within the E2B sandbox. ```APIDOC ## PUT /v1/proc/update ### Description Updates an existing process. ### Method PUT ### Endpoint /v1/proc/update ``` -------------------------------- ### List teams Source: https://e2b.dev/docs/llms.txt Lists all teams accessible by the user. ```APIDOC ## GET /teams ### Description List all teams. ### Method GET ### Endpoint /teams ``` -------------------------------- ### Refresh sandbox Source: https://e2b.dev/docs/llms.txt Refreshes the sandbox, extending its time to live. ```APIDOC ## POST /sandboxes/{sandboxID}/refresh ### Description Refresh the sandbox extending its time to live. ### Method POST ### Endpoint /sandboxes/{sandboxID}/refresh ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox to refresh. ``` -------------------------------- ### SendSignal Source: https://e2b.dev/docs/llms.txt Sends a signal to a process. ```APIDOC ## POST /v1/proc/sendsignal ### Description Sends a signal to a process. ### Method POST ### Endpoint /v1/proc/sendsignal ``` -------------------------------- ### GetWatcherEvents Source: https://e2b.dev/docs/llms.txt Retrieves events from a file system watcher. ```APIDOC ## GET /v1/fs/watchers/{watcher_id}/events ### Description Gets events from a file system watcher. ### Method GET ### Endpoint /v1/fs/watchers/{watcher_id}/events ``` -------------------------------- ### Stat Source: https://e2b.dev/docs/llms.txt Retrieves information about a file or directory. ```APIDOC ## GET /v1/fs/stat ### Description Gets information about a file or directory. ### Method GET ### Endpoint /v1/fs/stat ``` -------------------------------- ### Delete sandbox Source: https://e2b.dev/docs/llms.txt Terminates and deletes an existing sandbox instance. ```APIDOC ## DELETE /v1/sandboxes/{sandbox_id} ### Description Kills a sandbox. ### Method DELETE ### Endpoint /v1/sandboxes/{sandbox_id} ``` -------------------------------- ### List template tags Source: https://e2b.dev/docs/llms.txt Lists all tags associated with a specific template. ```APIDOC ## GET /templates/{templateID}/tags ### Description List all tags for a template. ### Method GET ### Endpoint /templates/{templateID}/tags ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template to list tags for. ``` -------------------------------- ### Remove Source: https://e2b.dev/docs/llms.txt Removes a file or directory from the E2B sandbox. ```APIDOC ## DELETE /v1/fs/remove ### Description Removes a file or directory. ### Method DELETE ### Endpoint /v1/fs/remove ``` -------------------------------- ### Pause sandbox Source: https://e2b.dev/docs/llms.txt Pauses the specified sandbox, halting its execution. ```APIDOC ## POST /sandboxes/{sandboxID}/pause ### Description Pause the sandbox. ### Method POST ### Endpoint /sandboxes/{sandboxID}/pause ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox to pause. ``` -------------------------------- ### Update sandbox network Source: https://e2b.dev/docs/llms.txt Updates the network configuration for a running sandbox. This replaces the current egress rules with the provided configuration. Omitting a field clears it. ```APIDOC ## PUT /sandboxes/{sandboxID}/network ### Description Update the network configuration for a running sandbox. Replaces the current egress rules with the provided configuration. Omitting field clears it. ### Method PUT ### Endpoint /sandboxes/{sandboxID}/network ### Parameters #### Path Parameters - **sandboxID** (string) - Required - The ID of the sandbox whose network configuration to update. #### Request Body - **egress** (object[]) - Optional - The egress rules for the sandbox. ``` -------------------------------- ### StreamInput Source: https://e2b.dev/docs/llms.txt Streams input data to a process. This is a client-streaming RPC that ensures message ordering. ```APIDOC ## POST /v1/proc/streaminput ### Description Client-streaming RPC. Client input stream ensures ordering of messages. Use the Connect protocol with streaming support. ### Method POST ### Endpoint /v1/proc/streaminput ``` -------------------------------- ### RemoveWatcher Source: https://e2b.dev/docs/llms.txt Removes a file system watcher. ```APIDOC ## DELETE /v1/fs/watchers/{watcher_id} ### Description Removes a file system watcher. ### Method DELETE ### Endpoint /v1/fs/watchers/{watcher_id} ``` -------------------------------- ### CloseStdin Source: https://e2b.dev/docs/llms.txt Closes the standard input stream for a process, signaling EOF. This is only applicable for non-PTY processes. For PTY processes, send Ctrl+D (0x04) instead. ```APIDOC ## POST /v1/proc/closestdin ### Description Close stdin to signal EOF to the process. Only works for non-PTY processes. For PTY, send Ctrl+D (0x04) instead. ### Method POST ### Endpoint /v1/proc/closestdin ``` -------------------------------- ### Update template (v2) Source: https://e2b.dev/docs/llms.txt Updates an existing template. This is the latest version for template updates. ```APIDOC ## PUT /v2/templates/{templateID} ### Description Update template. ### Method PUT ### Endpoint /v2/templates/{templateID} ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template to update. #### Request Body - **name** (string) - Optional - The new name for the template. - **description** (string) - Optional - The new description for the template. - **pkg** (string) - Optional - The new package name for the template. ``` -------------------------------- ### Check the health of the service Source: https://e2b.dev/docs/llms.txt Checks the health status of the E2B service. ```APIDOC ## GET /envd/health ### Description Checks the health of the E2B service. ### Method GET ### Endpoint /envd/health ``` -------------------------------- ### Delete template Source: https://e2b.dev/docs/llms.txt Deletes a specified template. ```APIDOC ## DELETE /templates/{templateID} ### Description Delete a template. ### Method DELETE ### Endpoint /templates/{templateID} ### Parameters #### Path Parameters - **templateID** (string) - Required - The ID of the template to delete. ``` -------------------------------- ### Delete tags Source: https://e2b.dev/docs/llms.txt Deletes multiple tags from templates. ```APIDOC ## DELETE /tags ### Description Delete multiple tags from templates. ### Method DELETE ### Endpoint /tags ### Parameters #### Query Parameters - **templateBuildIDs** (string[]) - Required - A list of template build IDs from which to delete tags. - **tags** (string[]) - Required - A list of tags to delete. ``` -------------------------------- ### Delete volumes Source: https://e2b.dev/docs/llms.txt Deletes a team volume. ```APIDOC ## DELETE /volumes/{volumeID} ### Description Delete a team volume. ### Method DELETE ### Endpoint /volumes/{volumeID} ### Parameters #### Path Parameters - **volumeID** (string) - Required - The ID of the volume to delete. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.