XPipe LogoXPipe Documentation

Query stores

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

POST
/store/query

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

categoryFilter*string

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

storeFilter*string

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

typeFilter*string

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

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:21721/store/query" \  -H "Content-Type: application/json" \  -d '{    "categoryFilter": "**",    "storeFilter": "**",    "typeFilter": "*"  }'
{
  "found": [
    "f0ec68aa-63f5-405c-b178-9a4454556d6b"
  ]
}
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [
      "string"
    ],
    "suppressed": [
      {}
    ],
    "localizedMessage": "string",
    "message": "string"
  }
}