XPipe LogoXPipe Documentation

Open terminal for shell connection

Launches a new terminal session for a connection with an optional specified working directory.

POST
/connection/terminal

Authorization

AuthorizationRequiredBearer <token>

The bearer token used is the session token that you receive from the handshake exchange.

In: header

Request Body

application/jsonRequired
directoryRequiredstring

The optional directory to use as the working directory

connectionRequiredstring

The connection uuid

curl -X POST "http://localhost:21721/connection/terminal" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "connection": "f0ec68aa-63f5-405c-b178-9a4454556d6b"
  }'

The request was successful. The connection was opened.