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

List the org's API keys (secrets are never returned)

Lists the keys that are not revoked, expired ones included. Keys are created and revoked on the website’s account page.

GET/v1/api-keys
Authorization
AuthorizationBearer token · headerrequired

Org-scoped API key, pols_....

Responses
200

The keys, newest first.

api_keysAPIKey[]required
Show properties
Array of APIKey
idstringrequired
namestringrequired
prefixstringrequired

The non-secret start of the key, for recognising it.

created_atstring<date-time>required
last_used_atstring<date-time> | null
expires_atstring<date-time> | null

When the key stops working; absent or null means never.

created_bystring | null

Who created the key: web:<user id> for a key made on my.pols.so/account; absent or null for keys made by the operator CLI or before creators were recorded, including keys made through the API before it stopped creating keys.

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/api-keys' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "api_keys": [
    {
      "id": "key_8f2k1m9x0q3z",
      "name": "string",
      "prefix": "pols_8f2k1m9x0q3z",
      "created_at": "2019-08-24T14:15:22Z",
      "last_used_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "created_by": "web:usr_3k9m2x7q1z0a"
    }
  ]
}