Rotate API Key
Tenant API
Rotate API Key
Generates a new API key and immediately invalidates the old one
POST
Rotate API Key
Overview
If your API key is compromised or you want to rotate it as a security practice, this endpoint generates a fresh key and immediately deactivates the old one.Request
Your current Aether Citadel API key (
ack_live_...). This key will be invalidated.Response
Your new API key. Update all environments that use the old key.
Confirmation message reminding you to update your integration.
Example
Rotation Checklist
After rotating your key, update it in:- Server environment variables (
.env, Kubernetes secrets, etc.) - CI/CD pipeline secrets
- Any queued jobs or scheduled tasks that use the key
- Partner integrations that call Citadel on your behalf
Error Responses
| Status | Error | Meaning |
|---|---|---|
401 | Missing X-Citadel-Key header | No key provided |
401 | Invalid or inactive API key | Key doesn’t exist or was already deactivated |
503 | Multi-tenancy not configured | Contact support |