---
title: "Query stores"
method: POST
path: "/store/query"
---

# Query stores

`POST /store/query`

## Request

- Base URL: `http://localhost:21721`
- URL: `http://localhost:21721/store/query`
- Auth: HTTP bearer

Queries all stores using various filters.

The filters support globs and can match the category names and store names.
All matching is case insensitive.

## Request body

- StoreQueryRequest
  - `categoryFilter` string, required: The filter string to match categories. Categories are delimited by / if they are hierarchical. The filter supports globs.
  - `storeFilter` string, required: The filter string to match store names. Store names are delimited by / if they are hierarchical. The filter supports globs.
  - `typeFilter` string, required: 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 `200`

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

- StoreQueryResponse
  - `found` string[], required: The found stores

## Other responses

- `400`: Bad request. Please check error message and your parameters.
- `401`: Authorization failed. Please supply a `Bearer` token via the `Authorization` header.
- `403`: Authorization failed. Please supply a valid `Bearer` token via the `Authorization` header.
- `500`: Internal error.

---

[API](https://skmtc.dev/xpipe/apis/xpipe-api-documentation.md) - [All operations](https://skmtc.dev/xpipe/apis/xpipe-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/xpipe/apis/xpipe-api-documentation/revisions/cc0e84caab21?raw)