XPipe LogoXPipe Documentation

Connection information

Queries detailed information about a connection.

POST
/connection/info

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

curl -X POST "http://localhost:21721/connection/info" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "connections": [
      "f0ec68aa-63f5-405c-b178-9a4454556d6b"
    ]
  }'

The query was successful. The body contains the detailed connection information.

{
  "summary": "Connection information",
  "value": {
    "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": {}
      }
    ]
  }
}