Disabling a key makes it invalid for verification without permanently deleting it. The key can be re-enabled at any time, restoring full access.
When to use this#
Payment issues
Customer's payment failed, disable their key until billing is resolved.
Suspicious activity
Investigate potential abuse without losing the key's configuration.
Scheduled maintenance
Temporarily block access during system updates.
Account suspension
Suspend a user's API access while keeping their key for potential reactivation.
Disable a key#
Verification response#
When a disabled key is verified, it returns valid: false with code DISABLED:
Re-enable a key#
Disabled vs Deleted#
| Action | Disabled | Deleted |
|---|---|---|
| Key verifies? | ❌ No (code: DISABLED) | ❌ No (code: NOT_FOUND) |
| Can be restored? | ✅ Yes | ❌ No |
| Keeps configuration? | ✅ Yes | ❌ No |
| Keeps analytics? | ✅ Yes | ⚠️ Limited |
Tip
Use disabling for temporary blocks. Only delete keys when you're sure the user won't need them again.