krzysztof/landing_page
1
0
Fork 0
mirror of https://github.com/qdrant/landing_page.git synced 2026-09-30 16:38:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document how to rotate an API key without any downtime (#2260)

Browse Source
This commit is contained in:
Abdon Pijpelink
2026-04-07 11:03:26 +02:00
committed by GitHub
parent 21b879266b
commit cbbd26e9b0
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qdrant-landing/content/documentation/operations/security.md
+20
View File
@@ -168,6 +168,26 @@ export QDRANT__SERVICE__READ_ONLY_API_KEY=your_secret_read_only_api_key_here
Both API keys can be used simultaneously.
### Rotate an API Key
*Available as of v1.17.0*
In a distributed deployment, you can rotate an API key without downtime. Use the `alt_api_key` setting to temporarily configure a second API key that acts identically to the primary `api_key`, allowing both the old and new API keys to be active at the same time.
```yaml
service:
api_key: your_current_api_key_here
alt_api_key: your_new_api_key_here
```
To rotate an API key without downtime:
1. Configure each peer with the new key set as `alt_api_key`. Restart only one peer at a time to avoid downtime (rolling restart). During the rotation window, requests authenticated with either key are accepted.
2. Switch clients to the new key.
3. Perform another rolling restart of the peers, promoting the new key to `api_key` and removing `alt_api_key`.
<aside role="alert">JWT tokens are tied to the key they were signed with and are <strong>not</strong> automatically migrated. They must be re-created after switching to the new key.</aside>
### Granular Access Control with JWT
*Available as of v1.9.0*