XPipe LogoXPipe Documentation
HTTP API

Get store info

Queries detailed information about a store.

POST
/store/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

stores*array<string>

The stores

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:21721/store/info" \  -H "Content-Type: application/json" \  -d '{    "stores": [      "f0ec68aa-63f5-405c-b178-9a4454556d6b"    ]  }'
{
  "infos": [
    {
      "store": "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",
      "created": "2024-05-31T10:32:02.508504600Z",
      "state": {}
    }
  ]
}
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [
      "string"
    ],
    "suppressed": [
      {}
    ],
    "localizedMessage": "string",
    "message": "string"
  }
}
Edit on GitHub

Add store POST

Creates the new store in the xpipe vault from raw json data. This can also perform an optional validation first to make sure that the store can be established. If an equivalent store already exists, no new one will be added and the existing one's ID will be returned. For details on the JSON schema of a connection type, take a look at the existing vault data of other connections.

Query stores POST

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