XPipe LogoXPipe Documentation

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

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/stop" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "connection": "f0ec68aa-63f5-405c-b178-9a4454556d6b"
  }'

The operation was successful. The shell session was stopped.