Skip to main content
POST
CreateWatcher

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).

Connect-Protocol-Version
enum<string>
required
Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
path
string
recursive
boolean
includeEntry
boolean

If true, each FilesystemEvent includes the EntryInfo of the affected entry, when available.

allowNetworkMounts
boolean

If true, allows watching paths on network filesystem mounts (NFS, CIFS, SMB, FUSE). Events on network mounts may be unreliable or not delivered at all.

Response

Success

watcherId
string