Remove connection | XPipe Docs

Removes a set of connection. This includes any possible children associated with the connection. Some connections, for example the local machine, can not be removed.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

connectionsRequiredarray<string>

The connections to remove

curl -X POST "http://localhost:21721/connection/remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "connections": [
      "36ad9716-a209-4f7f-9814-078d3349280c"
    ]
  }'

The removal was successful.