Sandboxes

Create Sandbox Connection

Returns a short-lived WebSocket URL for an interactive shell in a running sandbox. Connecting starts /bin/sh with a PTY. The connection has no stored history or reconnect support.

The URL contains a signed token that expires at expires_at. An open WebSocket can remain connected after the token expires. Clients send input as {"type":"input","data":"..."} and terminal size changes as {"type":"resize","rows":24,"cols":80}. The server returns terminal output as text frames. Closing the WebSocket ends the shell. Pausing or stopping the sandbox also closes the connection.

POST

api

sandboxes

{sid}

connections

Create a direct sandbox connection

curl --request POST \
  --url https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections \
  --header 'Authorization: <api-key>'

import requests

url = "https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections', 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://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": "Invalid request parameters"
}

{
  "success": false,
  "error": "Invalid request parameters"
}

{
  "success": false,
  "error": "Invalid request parameters"
}

{
  "success": false,
  "error": "Invalid request parameters"
}

Authorizations

Authorization

string

header

required

API key

Path Parameters

sid

string<uuid>

required

Sandbox UUID

Response

A short-lived direct connection URL

success

boolean

required

Example:

true

data

object

required

Show child attributes

⌘I

Create a direct sandbox connection

curl --request POST \
  --url https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections \
  --header 'Authorization: <api-key>'

import requests

url = "https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections', 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://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://control.green.us-east-1.aws.prod.archil.com/api/sandboxes/{sid}/connections")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": "Invalid request parameters"
}

{
  "success": false,
  "error": "Invalid request parameters"
}

{
  "success": false,
  "error": "Invalid request parameters"
}

{
  "success": false,
  "error": "Invalid request parameters"
}

Overview

Disks

Serverless Execution

Sandboxes

Disk Users

API Tokens

Create Sandbox Connection

Authorizations

Path Parameters

Response