Retrieve a key by ID

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

The id of the key to fetch

Decrypt and display the raw key. Only possible if the key was encrypted when generated.

The id of the key

The first few characters of the key to visually identify it

The id of the workspace that owns the key

The id of the api that this key is for

The name of the key, give keys a name to easily identify their purpose

The id of the tenant associated with this key. Use whatever reference you have in your system to identify the tenant. When verifying the key, we will send this field back to you, so you know who is accessing your API.

Any additional metadata you want to store with the key

The unix timestamp in milliseconds when the key was created

The unix timestamp in milliseconds when the key was last updated

The unix timestamp in milliseconds when the key will expire. If this field is null or undefined, the key is not expiring.

The number of requests that can be made with this key before it becomes invalid. If this field is null or undefined, the key has no request limit.

Unkey allows you to refill remaining verifications on a key on a regular interval.

Unkey comes with per-key ratelimiting out of the box.

All roles this key belongs to

All permissions this key has

Sets if key is enabled or disabled. Disabled keys are not valid.

The key in plaintext

The identity of the key