List keys

View as MarkdownThe page as plain text

Return every API key in the project, with what each one can do and when it was last used.

GET/v1/keys

Keys are shown shortened. The full key is only returned once, when you create it. Requires an admin key.

Response

results[].uidstring

The id of the key, used to delete it.

results[].kindadmin | search

What the key can do.

results[].indexesstring[]

The indexes the key can reach. * means every index.

results[].lastUsedAtstring | null

When the key last made a request. Useful to find keys that are safe to revoke.

Request

curl https://api.zeroindex.test/v1/keys \
  -H "Authorization: Bearer $ZEROINDEX_KEY"

const { results } = await client.keys.list();

keys = client.keys.list()

Response

200

{
  "results": [
    {
      "uid": "b3f1c9a2",
      "name": "Storefront search",
      "kind": "search",
      "key": "zi_search_7b1e…",
      "indexes": ["products"],
      "lastUsedAt": "2026-10-08T21:13:40Z",
      "createdAt": "2026-08-02T10:25:00Z"
    },
    {
      "uid": "4e07d6b8",
      "name": "Sync worker",
      "kind": "admin",
      "key": "zi_admin_4f8a…",
      "indexes": ["*"],
      "lastUsedAt": "2026-10-08T21:14:02Z",
      "createdAt": "2026-08-02T10:24:12Z"
    }
  ],
  "total": 2
}