List Keys

GET

https://acme.captain.dev/v1/keys

GET

/v1/keys

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/keys",
    headers=headers,
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Retrieved

{
  "keys": [
    {
      "id": "key_2c7e90a1b4d35f18",
      "type": "write",
      "prefix": "cap_Q2mz7a",
      "indexes": [
        "*"
      ],
      "description": "bootstrap write key",
      "created_at": 1759000000,
      "current": true
    },
    {
      "id": "key_8a1f3c0d9e2b4f67",
      "type": "search",
      "prefix": "cap_k3Jd9x",
      "indexes": [
        "products-staging"
      ],
      "description": "staging storefront",
      "created_at": 1759433001,
      "created_by": "key_2c7e90a1b4d35f18"
    }
  ]
}

List every key, never its secret. The calling key has current: true. Takes a write key for every index.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Response

keys

keyslist of objectsOptional