Skip to content
pols.so docs
Esc
↑↓navigate↵open⌘Jpreview

List the org's vault entries (values are never returned)

Names, kinds and timestamps of the entries a sandbox can be given with secrets. Entries are managed by the org’s owner at https://my.pols.so/account, not with API keys. Answers 503 when the deployment has no vault key.

GET/v1/vault
Authorization
AuthorizationBearer token · headerrequired

Org-scoped API key, pols_....

Responses
200

The entries, by name.

entriesVaultEntry[]required
Show properties
Array of VaultEntry
nameVaultEntryNamerequired

An environment variable name; the sandbox gets the value under it.

matches ^[A-Za-z_][A-Za-z0-9_]{0,127}$
kindVaultKindrequired

What the entry holds. Both kinds reach a sandbox the same way.

Allowed:passwordenv
created_atstring<date-time>required
updated_atstring<date-time>required

When the value was last set.

last_used_atstring<date-time> | null

When a sandbox last got the value.

429

Rate limited (rate_limited): too many requests or failed authentications from this address, too many requests or lifecycle calls for this org, or too many of its exec, file, computer and CDP calls in progress at once. Retry after Retry-After seconds.

errorobjectrequired
Show properties
codestringrequired

Stable machine-readable code: bad_request (400), unauthorized (401), forbidden (403), quota_exceeded (403), not_found (404), conflict (409), rate_limited (429, see Retry-After), internal (500), runtime_error (502, the sandbox host failed), unavailable (503, the feature is not configured on this deployment), timeout (504, or 408 when a request body stalls).

messagestringrequired
default

Error.

errorobjectrequired
Show properties
codestringrequired

Stable machine-readable code: bad_request (400), unauthorized (401), forbidden (403), quota_exceeded (403), not_found (404), conflict (409), rate_limited (429, see Retry-After), internal (500), runtime_error (502, the sandbox host failed), unavailable (503, the feature is not configured on this deployment), timeout (504, or 408 when a request body stalls).

messagestringrequired
Request
curl -X GET 'https://api.pols.so/v1/vault' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "entries": [
    {
      "name": "ANTHROPIC_API_KEY",
      "kind": "password",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "last_used_at": "2019-08-24T14:15:22Z"
    }
  ]
}