XPipe LogoXPipe Documentation
HTTP API

Stop shell connection

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.

POST
/shell/stop

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

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

Start shell connection POST

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.

Python API

Interacting with XPipe from Python