Skip to main content
POST
/
api
/
v1
/
terminal
/
create
Create terminal session
curl --request POST \
  --url http://localhost:3000/api/v1/terminal/create \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "cols": 80,
  "rows": 24,
  "cwd": "<string>"
}
'
{
  "success": true,
  "data": {
    "session": {
      "id": "<string>",
      "pid": 123,
      "cols": 123,
      "rows": 123,
      "cwd": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Body

application/json
cols
integer
default:80

Terminal columns

rows
integer
default:24

Terminal rows

cwd
string

Working directory

Response

Terminal session created

success
boolean
required
data
object