Query connections

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

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

categoryFilterRequiredstring

The filter string to match categories. Categories are delimited by / if they are hierarchical. The filter supports globs.

connectionFilterRequiredstring

The filter string to match connection names. Connection names are delimited by / if they are hierarchical. The filter supports globs.

typeFilterRequiredstring

The filter string to connection types. Every unique type of connection like SSH or docker has its own type identifier that you can match. The filter supports globs.

curl -X POST "http://localhost:21721/connection/query" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryFilter": "**",
    "connectionFilter": "**",
    "typeFilter": "*"
  }'

The query was successful. The body contains all matched connections.

{
  "summary": "Matched connections",
  "value": {
    "found": [
      "f0ec68aa-63f5-405c-b178-9a4454556d6b"
    ]
  }
}

Authorization

Request Body

Matched connections

TypeScript