Keys / Weaviate

WEAVIATE_API_KEY

The API key your app connects to a Weaviate Cloud cluster or a self-hosted Weaviate database with.

Expires
the docs don't say
API
self-hosted: create, rotate and delete users' keys; Cloud: none documented

Get it

Create one on console.weaviate.cloud. The steps aren't recorded yet.

Set it

WEAVIATE_API_KEY=...

The client libraries don't read it on their own; your app passes it in, for example as auth_credentials in Python or new weaviate.ApiKey() in TypeScript. Or keep it out of .env with keypin: keypin run -- npm run dev

Replace it

  1. On Weaviate Cloud, open the cluster's API Keys section and click Rotate next to the key. Rotating invalidates the old key, so deploy the new one right away. To avoid a gap, create a second key with the same role instead, and delete the old one when nothing uses it.
  2. Self-hosted with the user management API, rotate_key gives the database user a new key in place of the old one.
  3. Self-hosted with AUTHENTICATION_APIKEY_ALLOWED_KEYS, add the new key next to the old one, with its user in AUTHENTICATION_APIKEY_USERS, and restart. Move every client to the new key, then remove the old one and restart again.
  4. Each new key is shown only once. Put it everywhere that reads WEAVIATE_API_KEY.

Set rotate_every on the key in keypin.toml and a rotated date on its vault item, and keypin status shows when it's due.

Sources, checked 2026-11-16