Overview
Revoke the API token currently being used for authentication. The token is identified by theX-API-Key header you send with the request. Once revoked, the token can no longer be used for authentication. This is useful for:
- Rotating tokens for security
- Removing compromised tokens
- Cleaning up unused tokens
Important Notes
⚠️ Warning: Once a token is revoked, it cannot be restored. You’ll need to create a new token if needed. ✅ Best Practice: Before revoking a token, ensure no active integrations are using it, or create a replacement token first. ⚠️ Important: This endpoint revokes the token you’re currently using (the one in theX-API-Key header). You cannot revoke other tokens using this endpoint.
Token Rotation Flow
- Generate a new token via
POST /auth/token - Update your application with the new token
- Test the new token works
- Revoke the old token via this endpoint using the old token’s
X-API-Keyheader
Authorizations
API Key for authentication
Response
OK
Example:
"Token revoked successfully"
