| Field | Type | Required | Description | Example |
|---|---|---|---|---|
keyId |
string | ✔️ | The id of the key you want to modify | key_123 |
name |
string | ➖ | The name of the key | Customer X |
ownerId |
string | ➖ | 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. | user_123 |
meta |
Record<string, any> | ➖ | Any additional metadata you want to store with the key | { "roles": [ "admin", "user" ], "stripeCustomerId": "cus_1234" } |
expires |
number | ➖ | The unix timestamp in milliseconds when the key will expire. If this field is null or undefined, the key is not expiring. | 0 |
ratelimit |
operations.PostV1KeysUpdateKeyRatelimit | ➖ | Unkey comes with per-key ratelimiting out of the box. Set null to disable. |
{ "type": "fast", "limit": 10, "refillRate": 1, "refillInterval": 60 } |
remaining |
number | ➖ | The number of requests that can be made with this key before it becomes invalid. Set null to disable. |
1000 |
refill |
operations.PostV1KeysUpdateKeyRefill | ➖ | Unkey enables you to refill verifications for each key at regular intervals. | { "interval": "daily", "amount": 100 } |
enabled |
boolean | ➖ | Set if key is enabled or disabled. If disabled, the key cannot be used to verify. | true |