Official Libraries
- @unkey/api
- Overview
- Keys
- APIs
- Identities
- Ratelimits
- Migrations
- Permissions
- @unkey/ratelimit
- @unkey/nextjs
- @unkey/hono
- @unkey/cache
- unkey-go
- unkey.py
Community Libraries
- Elixir
- Nuxt
- Rust
- Springboot
Get
Get the configuration for an api key
const { result, error } = await unkey.keys.get({ keyId: "key_123" });
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}
console.log(result){
"result": {
"id": "key_123",
"start": "3ZHF3",
"apiId": "api_123",
"workspaceId": "ws_123",
"meta": {},
"createdAt": 1747222842094,
"roles": [],
"permissions": [],
"enabled": true
}
}const { result, error } = await unkey.keys.get({ keyId: "key_123" });
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}
console.log(result){
"result": {
"id": "key_123",
"start": "3ZHF3",
"apiId": "api_123",
"workspaceId": "ws_123",
"meta": {},
"createdAt": 1747222842094,
"roles": [],
"permissions": [],
"enabled": true
}
}Request
The ID of the key you want to retrieve.
Response
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 deleted. We don’t delete the key outright, you can restore it later.
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.
Determines the rate at which verifications will be refilled.
Available options:
daily: Refills occur every daymonthly: Refills occur once a month (seerefillDayfor specific day)
Resets remaining to this value every interval.
value from 1 to 31.
The day each month to refill ‘remaining’. If no value is given, The 1st will be used as a default.
Read more here
The unix timestamp in miliseconds when the key was last refilled.
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.
All roles this key belongs to
Example”
["admin", "finance"]All permissions this key has
Example”
["domain.dns.create_record","finance.read_receipt"]Example: true
The key in plaintext
Was this page helpful?
const { result, error } = await unkey.keys.get({ keyId: "key_123" });
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}
console.log(result){
"result": {
"id": "key_123",
"start": "3ZHF3",
"apiId": "api_123",
"workspaceId": "ws_123",
"meta": {},
"createdAt": 1747222842094,
"roles": [],
"permissions": [],
"enabled": true
}
}