XPipe LogoXPipe Documentation
HTTP API

Refresh connection

Performs a refresh on the specified connection. This will update the connection state information and also any children if the connection type has any.

POST
/connection/refresh

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/connection/refresh" \  -H "Content-Type: application/json" \  -d '{    "connection": "36ad9716-a209-4f7f-9814-078d3349280c"  }'
Empty
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [],
    "suppressed": [],
    "localizedMessage": "string",
    "message": "string"
  }
}
Edit on GitHub

Query connections POST

Queries all connections using various filters. The filters support globs and can match the category names and connection names. All matching is case insensitive.

Remove connection POST

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