Add store
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.
Authorization
bearerAuth The bearer token used is the session token that you receive from the handshake exchange.
In: header
Request Body
application/json
The store name
The raw store store data. Schemas for store types are not documented, but you can find the store data of your existing stores in the xpipe vault.
Whether to perform a store validation before adding it, i.e., probe the store first. If validation is enabled and fails, the store will not be added
The category uuid to put the store in. If not specified, the default category will be used
Response Body
application/json
application/json
application/json
curl -X POST "http://localhost:21721/store/add" \ -H "Content-Type: application/json" \ -d '{ "name": "my connection", "validate": true, "category": "97458c07-75c0-4f9d-a06e-92d8cdf67c40", "data": { "type": "shellEnvironment", "commands": null, "host": "f0ec68aa-63f5-405c-b178-9a4454556d6b", "shell": "pwsh", "elevated": false } }'{
"store": "36ad9716-a209-4f7f-9814-078d3349280c"
}{
"message": "string"
}{
"error": {
"cause": {},
"stackTrace": [
"string"
],
"suppressed": [
{}
],
"localizedMessage": "string",
"message": "string"
}
}