Update PTY session

Update properties of an existing pseudo-terminal (PTY) session.

PUT /pty/{ptyID}

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.pty.update({
  ...
})

200

{
  "id": "<string>",
  "title": "<string>",
  "command": "<string>",
  "args": [
    "<string>"
  ],
  "cwd": "<string>",
  "status": "running",
  "pid": 123
}

Path Parameters

ptyID · string · required

Pattern: ^pty.*

Query Parameters

directory · string

workspace · string

Body

application/json

title · string

size · object

Show child attributes

Response

200

application/json

Updated session

id · string · required

Pattern: ^pty.*

title · string · required

command · string · required

args · string[] · required

cwd · string · required

status · enum<string> · required

Available options: running, exited

pid · number · required