Skip to main content
PUT
/
api
/
pty
/
{ptyID}
Update PTY session
curl --request PUT \
  --url https://api.example.com/api/pty/{ptyID} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>"
}
'
import requests

url = "https://api.example.com/api/pty/{ptyID}"

payload = { "title": "<string>" }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({title: '<string>'})
};

fetch('https://api.example.com/api/pty/{ptyID}', 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/pty/{ptyID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>'
  ]),
  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/pty/{ptyID}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/pty/{ptyID}")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/pty/{ptyID}")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "location": {
    "directory": "<string>",
    "project": {
      "id": "<string>",
      "directory": "<string>"
    },
    "workspaceID": "<string>"
  },
  "data": {
    "id": "<string>",
    "title": "<string>",
    "command": "<string>",
    "args": [
      "<string>"
    ],
    "cwd": "<string>",
    "pid": 1,
    "exitCode": 1
  }
}
{
  "_tag": "InvalidRequestError",
  "message": "<string>",
  "kind": "<string>",
  "field": "<string>"
}
{
  "_tag": "UnauthorizedError",
  "message": "<string>"
}
{
  "_tag": "PtyNotFoundError",
  "ptyID": "<string>",
  "message": "<string>"
}

Path Parameters

​
ptyID
string
required
Pattern: ^pty

Query Parameters

​
location
object | null

Body

application/json
​
title
string
​
size
object

Response

Success

​
location
object
required
​
data
object
required