Skip to main content
POST
/
api
/
v1
/
vault
/
entries
Save vault entry
curl --request POST \
  --url http://localhost:3000/api/v1/vault/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent": "<string>",
  "service": "<string>",
  "type": "smtp",
  "credentials": {},
  "label": "<string>"
}
'
{
  "ok": true,
  "data": {
    "agent": "<string>",
    "service": "<string>",
    "type": "<string>",
    "keys": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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
string
required

Agent name

Minimum string length: 1
​
service
string
required

Service name (vault key)

Minimum string length: 1
​
type
enum<string>
required

Credential type

Available options:
smtp,
imap,
oauth,
api_key,
login,
custom
​
credentials
object
required

Key-value credential fields

​
label
string

Human-readable label

Response

Vault entry saved successfully

​
ok
boolean
required
​
data
object
required