Skip to main content
POST
/
filesystem.Filesystem
/
CreateWatcher
CreateWatcher
curl --request POST \
  --url https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Token: <api-key>' \
  --data '
{
  "path": "<string>",
  "recursive": true
}
'
import requests

url = "https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher"

payload = {
    "path": "<string>",
    "recursive": True
}
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "X-Access-Token": "<api-key>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    'X-Access-Token': '<api-key>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({path: '<string>', recursive: true})
};

fetch('https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<string>',
    'recursive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json",
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"recursive\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("X-Access-Token", "<api-key>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("X-Access-Token", "<api-key>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"recursive\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{port}-{sandboxID}.e2b.app/filesystem.Filesystem/CreateWatcher")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["X-Access-Token"] = '<api-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"recursive\": true\n}"

response = http.request(request)
puts response.read_body
{
  "watcherId": "<string>"
}
{
  "message": "<string>",
  "code": 123,
  "sandboxID": "<string>"
}

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

​
Authorization
string
header
required

Optional system user for the operation. Sets file ownership and resolves relative paths. Pass the desired username with no password. Defaults to the sandbox's default user when omitted.

Headers

​
Connect-Protocol-Version
number
required

Define the version of the Connect protocol

​
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
​
path
string
​
recursive
boolean

Response

Success

​
watcherId
string