Skip to main content
POST
/
process.Process
/
Connect
Connect
curl --request POST \
  --url https://sandbox.{domain}/process.Process/Connect \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/connect+json' \
  --header 'E2b-Sandbox-Id: <e2b-sandbox-id>' \
  --header 'E2b-Sandbox-Port: <e2b-sandbox-port>' \
  --header 'X-Access-Token: <api-key>' \
  --data '
{
  "process": {
    "pid": 123
  }
}
'
import requests

url = "https://sandbox.{domain}/process.Process/Connect"

payload = { "process": { "pid": 123 } }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "E2b-Sandbox-Id": "<e2b-sandbox-id>",
    "E2b-Sandbox-Port": "<e2b-sandbox-port>",
    "X-Access-Token": "<api-key>",
    "Content-Type": "application/connect+json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    'E2b-Sandbox-Id': '<e2b-sandbox-id>',
    'E2b-Sandbox-Port': '<e2b-sandbox-port>',
    'X-Access-Token': '<api-key>',
    'Content-Type': 'application/connect+json'
  },
  body: JSON.stringify({process: {pid: 123}})
};

fetch('https://sandbox.{domain}/process.Process/Connect', 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://sandbox.{domain}/process.Process/Connect",
  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([
    'process' => [
        'pid' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/connect+json",
    "E2b-Sandbox-Id: <e2b-sandbox-id>",
    "E2b-Sandbox-Port: <e2b-sandbox-port>",
    "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://sandbox.{domain}/process.Process/Connect"

	payload := strings.NewReader("{\n  \"process\": {\n    \"pid\": 123\n  }\n}")

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

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("E2b-Sandbox-Id", "<e2b-sandbox-id>")
	req.Header.Add("E2b-Sandbox-Port", "<e2b-sandbox-port>")
	req.Header.Add("X-Access-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/connect+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://sandbox.{domain}/process.Process/Connect")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("E2b-Sandbox-Id", "<e2b-sandbox-id>")
  .header("E2b-Sandbox-Port", "<e2b-sandbox-port>")
  .header("X-Access-Token", "<api-key>")
  .header("Content-Type", "application/connect+json")
  .body("{\n  \"process\": {\n    \"pid\": 123\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.{domain}/process.Process/Connect")

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["E2b-Sandbox-Id"] = '<e2b-sandbox-id>'
request["E2b-Sandbox-Port"] = '<e2b-sandbox-port>'
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/connect+json'
request.body = "{\n  \"process\": {\n    \"pid\": 123\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "event": {
    "data": {
      "pty": "aSDinaTvuI8gbWludGxpZnk="
    }
  }
}
{
  "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).

Headers

​
Connect-Protocol-Version
number
required

Define the version of the Connect protocol

​
Connect-Timeout-Ms
number

Define the timeout, in ms

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

Body

application/connect+json
​
process
process · object

Response

Stream of ConnectResponse events

​
event
event · object