Disabling Keys

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

curl -X POST https://api.unkey.com/v2/keys.updateKey \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyId": "key_...",
    "enabled": false
  }'

import { Unkey } from "@unkey/api";

const unkey = new Unkey({ rootKey: process.env.UNKEY_ROOT_KEY });

try {
  const { meta, data } = await unkey.keys.updateKey({
    keyId: "key_...",
    enabled: false,
  });
} catch (err) {
  console.error(err);
  return Response.json({ error: "Internal error" }, { status: 500 });
}

Verification response

When a disabled key is verified, it returns valid: false with code DISABLED:

{
  "meta": { "requestId": "req_..." },
  "data": {
    "valid": false,
    "code": "DISABLED",
    "keyId": "key_...",
    "enabled": false
  }
}

Re-enable a key

curl -X POST https://api.unkey.com/v2/keys.updateKey \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyId": "key_...",
    "enabled": true
  }'

try {
  const { meta, data } = await unkey.keys.updateKey({
    keyId: "key_...",
    enabled: true,
  });
} catch (err) {
  console.error(err);
  return Response.json({ error: "Internal error" }, { status: 500 });
}

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

Use disabling for temporary blocks. Only delete keys when you’re sure the user won’t need them again.

Getting Started

Platform

Build & Deploy

Networking

Observability

CLI

Security

Keyspaces

AI Code Gen

Audit Logs

CLI

Errors

When to use this

Payment issues

Suspicious activity

Scheduled maintenance

Account suspension

Disable a key

Verification response

Re-enable a key

Disabled vs Deleted

​When to use this

Payment issues

Suspicious activity

Scheduled maintenance

Account suspension

​Disable a key

​Verification response

​Re-enable a key

​Disabled vs Deleted

When to use this

Disable a key

Verification response

Re-enable a key

Disabled vs Deleted