XPipe LogoXPipe Documentation
HTTP API

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

bearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

connection*string

The connection uuid

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:21721/shell/start" \  -H "Content-Type: application/json" \  -d '{    "connection": "f0ec68aa-63f5-405c-b178-9a4454556d6b"  }'
{
  "shellDialect": 0,
  "osType": "string",
  "osName": "string",
  "ttyState": "string",
  "temp": "string"
}
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [],
    "suppressed": [],
    "localizedMessage": "string",
    "message": "string"
  }
}
Edit on GitHub

Run command in shell session POST

Runs a command in an active shell session and waits for it to finish. The exit code and output will be returned in the response. Note that a variety of different errors can occur when executing the command. If the command finishes, even with an error code, a normal HTTP 200 response will be returned. However, if any other error occurs like the shell not responding or exiting unexpectedly, an HTTP 500 response will be returned.

Stop shell connection POST

Stops an existing shell session for a connection. This operation will return once the shell has exited. If the shell is busy or stuck, you might have to work with timeouts to account for these cases.