Key rotation
Rotate a key when it is close to expiry, when someone who had access leaves, or straight away if you think it has leaked. Ask for the new key as in Get API keys.
Planned rotation
Section titled “Planned rotation”Private keys expire at most one year after they are issued. Ask for the new key while the old one still works, so the swap has no gap:
- Ask for a new key a few weeks before the old one expires. It gets the same allowlist and scopes unless you ask for a change.
- Deploy the new key to every server that calls the API.
- Check it works:
GET /healthwith the new key returns200. - Ask us to revoke the old key. Revocation takes effect within 10 seconds.
After a leak
Section titled “After a leak”Ask us to revoke first, then issue a replacement. Revoking is instant on our side (within 10 seconds); your integration is down only until you deploy the new key. Then check how it leaked (a repository, a log line, a shared screenshot) and close that path.
With request signing
Section titled “With request signing”When request signing ships, the signing key pair is yours: you rotate it by sending us a new public half. The exact steps will be published with the feature.
