XPipe LogoXPipe Documentation
HTTP API

Get connection info

Queries detailed information about a connection.

POST
/connection/info

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

connections*array<string>

The connections

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:21721/connection/info" \  -H "Content-Type: application/json" \  -d '{    "connections": [      "f0ec68aa-63f5-405c-b178-9a4454556d6b"    ]  }'
{
  "infos": [
    {
      "connection": "f0ec68aa-63f5-405c-b178-9a4454556d6b",
      "category": [
        "default"
      ],
      "name": [
        "local machine"
      ],
      "type": "local",
      "rawData": {},
      "usageCategory": "shell",
      "lastUsed": "2024-05-31T11:53:02.408504600Z",
      "lastModified": "2024-06-23T21:15:25.608097Z",
      "state": {}
    }
  ]
}
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [],
    "suppressed": [],
    "localizedMessage": "string",
    "message": "string"
  }
}
Edit on GitHub

Add connection POST

Creates the new connection in the xpipe vault from raw json data. This can also perform an optional validation first to make sure that the connection can be established. If an equivalent connection already exists, no new one will be added.

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.