XPipe LogoXPipe Documentation

Start shell connection

Starts a new shell session for a connection. If an existing shell session is already running for that connection, this operation will do nothing. Note that there are a variety of possible errors that can occur here when establishing the shell connection. These errors will be returned with the HTTP return code 500.

POST
/shell/start

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired
connectionRequiredstring

The connection uuid

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

The operation was successful. The shell session was started.

{
  "shellDialect": 0,
  "osType": "string",
  "osName": "string",
  "ttyState": "string",
  "temp": "string"
}