Skip to main content
POST
Upload a file and ensure the parent directories exist. If the file exists, it will be overwritten.

Authorizations

X-Access-Token
string
header
required

Sandbox access token (envdAccessToken) for authenticating requests to a running sandbox. Returned by: POST /sandboxes (on create), POST /sandboxes/{sandboxID}/connect (on connect), POST /sandboxes/{sandboxID}/resume (on resume), and GET /sandboxes/{sandboxID} (for running or paused sandboxes).

Headers

E2b-Sandbox-Id
string
required

Identifier of the target sandbox. Routes the request to that sandbox's envd over the shared sandbox host.

E2b-Sandbox-Port
integer
default:49983
required

Port envd listens on inside the sandbox (default 49983).

Query Parameters

path
string

Path to the file, URL encoded. Can be relative to the user's home directory (e.g. "file.txt" resolves to ~/file.txt).

username
string

User for setting file ownership and resolving relative paths. Defaults to the sandbox's default user.

signature
string

Signature used for file access permission verification.

signature_expiration
integer

Unix timestamp (seconds) after which the signature expires. Only used with the signature parameter.

Body

file
file

Response

The file was uploaded successfully.

path
string
required

Path to the file

name
string
required

Name of the file

type
enum<string>
required

Type of the file

Available options:
file,
directory
metadata
object

User-defined metadata stored as extended attributes on the file.