Skip to main content
PATCH
/
api
/
shell
/
{id}
/
timeout
Update shell timeout
curl --request PATCH \
  --url https://api.example.com/api/shell/{id}/timeout \
  --header 'Content-Type: application/json' \
  --data '{
  "timeout": 1
}'
import requests

url = "https://api.example.com/api/shell/{id}/timeout"

payload = { "timeout": 1 }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({timeout: 1})
};

fetch('https://api.example.com/api/shell/{id}/timeout', 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/api/shell/{id}/timeout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'timeout' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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://api.example.com/api/shell/{id}/timeout"

payload := strings.NewReader("{\n \"timeout\": 1\n}")

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

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.patch("https://api.example.com/api/shell/{id}/timeout")
.header("Content-Type", "application/json")
.body("{\n \"timeout\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/shell/{id}/timeout")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"timeout\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "location": {
    "directory": "<string>",
    "project": {
      "id": "<string>",
      "directory": "<string>"
    },
    "workspaceID": "<string>"
  },
  "data": {
    "id": "<string>",
    "command": "<string>",
    "cwd": "<string>",
    "shell": "<string>",
    "file": "<string>",
    "metadata": {},
    "time": {
      "started": 123,
      "completed": 123
    },
    "pid": 1,
    "exit": 123
  }
}
{
"_tag": "InvalidRequestError",
"message": "<string>",
"kind": "<string>",
"field": "<string>"
}
{
"_tag": "UnauthorizedError",
"message": "<string>"
}
{
"_tag": "ShellNotFoundError",
"id": "<string>",
"message": "<string>"
}

Path Parameters

id
string
required
Pattern: ^sh_

Query Parameters

location
object | null

Body

application/json
timeout
integer
required
Required range: x >= 0

Response

Success

location
object
required
data
object
required