GET
/
v1
/
projects
/
{project}
/
boxes
/
{name}
/
console
WebSocket console connection
curl --request GET \
  --url https://api.example.com/v1/projects/{project}/boxes/{name}/console
import requests

url = "https://api.example.com/v1/projects/{project}/boxes/{name}/console"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/projects/{project}/boxes/{name}/console', 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://api.example.com/v1/projects/{project}/boxes/{name}/console",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/v1/projects/{project}/boxes/{name}/console"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/projects/{project}/boxes/{name}/console")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/projects/{project}/boxes/{name}/console")

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

request = Net::HTTP::Get.new(url)

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

Path Parameters

project
string
required

Project name

name
string
required

Box name

Query Parameters

tty
boolean

Enable TTY mode

cmd
string

Command to run

term
string

TERM value for the remote session

Response

WebSocket upgrade