Disabling Keys

This feature is useful for disabling a key temporarily. While disabled the key will act as an invalid key.

Example: Suppose you have a customer that has not paid their bill. You may not want to delete the key and wait for the account balance to be current. The key can be disabled temporarily, preventing access until it is enabled.

Unkey allows you to disable a key on an individual basis.

​

Example

Let’s disable a key temperarily blocking access with that key.

curl --request POST \
  --url https://api.unkey.dev/v1/keys.updateKey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": false,
  "keyId": "<keyId>"
}'

Now, when you verify the updated key it will show as invalid.

curl --request POST \
  --url https://api.unkey.dev/v1/keys.verifyKey \
  --header 'Content-Type: application/json' \
  --data '{
		"key": "<NEW_KEY>"
	}'

{
  "keyId": "<KEY_ID>",
  "valid": false,
  "meta": {},
  "enabled": false
}