Skip to main content
POST
/
api
/
v1
/
terminal
/
{taskId}
/
create
Create terminal session
curl --request POST \
  --url http://localhost:3001/api/v1/terminal/{taskId}/create \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "startupCommand": "<string>"
}
'
{
  "sessionId": "<string>",
  "taskId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Path Parameters

taskId
string
required

Task ID to associate the terminal session with

Body

application/json
startupCommand
string

Optional command to run on session start

Response

Terminal session created

sessionId
string
taskId
string
createdAt
string<date-time>