Save vault entry
curl --request POST \
--url http://localhost:3890/api/v1/vault/entries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent": "<string>",
"service": "<string>",
"credentials": {},
"label": "<string>"
}
'import requests
url = "http://localhost:3890/api/v1/vault/entries"
payload = {
"agent": "<string>",
"service": "<string>",
"credentials": {},
"label": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent: '<string>', service: '<string>', credentials: {}, label: '<string>'})
};
fetch('http://localhost:3890/api/v1/vault/entries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3890",
CURLOPT_URL => "http://localhost:3890/api/v1/vault/entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent' => '<string>',
'service' => '<string>',
'credentials' => [
],
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3890/api/v1/vault/entries"
payload := strings.NewReader("{\n \"agent\": \"<string>\",\n \"service\": \"<string>\",\n \"credentials\": {},\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3890/api/v1/vault/entries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent\": \"<string>\",\n \"service\": \"<string>\",\n \"credentials\": {},\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3890/api/v1/vault/entries")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": \"<string>\",\n \"service\": \"<string>\",\n \"credentials\": {},\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"agent": "<string>",
"service": "<string>",
"type": "<string>",
"keys": [
"<string>"
]
}
}{
"ok": true,
"error": "<string>"
}Vault
Save vault entry
Save credentials to the encrypted vault store. Credentials are encrypted at rest (AES-256-GCM) and never logged or persisted in chat history.
POST
/
api
/
v1
/
vault
/
entries
Save vault entry
curl --request POST \
--url http://localhost:3890/api/v1/vault/entries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent": "<string>",
"service": "<string>",
"credentials": {},
"label": "<string>"
}
'import requests
url = "http://localhost:3890/api/v1/vault/entries"
payload = {
"agent": "<string>",
"service": "<string>",
"credentials": {},
"label": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent: '<string>', service: '<string>', credentials: {}, label: '<string>'})
};
fetch('http://localhost:3890/api/v1/vault/entries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3890",
CURLOPT_URL => "http://localhost:3890/api/v1/vault/entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent' => '<string>',
'service' => '<string>',
'credentials' => [
],
'label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3890/api/v1/vault/entries"
payload := strings.NewReader("{\n \"agent\": \"<string>\",\n \"service\": \"<string>\",\n \"credentials\": {},\n \"label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3890/api/v1/vault/entries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent\": \"<string>\",\n \"service\": \"<string>\",\n \"credentials\": {},\n \"label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3890/api/v1/vault/entries")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": \"<string>\",\n \"service\": \"<string>\",\n \"credentials\": {},\n \"label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"agent": "<string>",
"service": "<string>",
"type": "<string>",
"keys": [
"<string>"
]
}
}{
"ok": true,
"error": "<string>"
}Authorizations
API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.
Body
application/json
Agent name
Minimum string length:
1Service name (vault key)
Minimum string length:
1Credential type
Available options:
smtp, imap, oauth, api_key, login, custom Key-value credential fields
Show child attributes
Show child attributes
Human-readable label
⌘I