| Field | Type | Required | Description | Example |
|---|---|---|---|---|
prefix |
Optional[str] | ➖ | To make it easier for your users to understand which product an api key belongs to, you can add prefix them. For example Stripe famously prefixes their customer ids with cus_ or their api keys with sk_live_. The underscore is automatically added if you are defining a prefix, for example: "prefix": "abc" will result in a key like abc_xxxxxxxxx |
|
name |
Optional[str] | ➖ | The name for your Key. This is not customer facing. | my key |
plaintext |
Optional[str] | ➖ | The raw key in plaintext. If provided, unkey encrypts this value and stores it securely. Provide either hash or plaintext |
|
hash |
Optional[models.V1MigrationsEnqueueKeysHash] | ➖ | Provide either hash or plaintext |
|
start |
Optional[str] | ➖ | The first 4 characters of the key. If a prefix is used, it should be the prefix plus 4 characters. | unkey_32kq |
owner_id |
Optional[str] | ➖ | Your user’s Id. This will provide a link between Unkey and your customer record. When validating a key, we will return this back to you, so you can clearly identify your user from their api key. |
team_123 |
meta |
Dict[str, Any] | ➖ | This is a place for dynamic meta data, anything that feels useful for you should go here | { "billingTier": "PRO", "trialEnds": "2023-06-16T17:16:37.161Z" } |
roles |
List[str] | ➖ | A list of roles that this key should have. If the role does not exist, an error is thrown | [ "admin", "finance" ] |
permissions |
List[str] | ➖ | A list of permissions that this key should have. If the permission does not exist, an error is thrown | [ "domains.create_record", "say_hello" ] |
expires |
Optional[int] | ➖ | You can auto expire keys by providing a unix timestamp in milliseconds. Once Keys expire they will automatically be disabled and are no longer valid unless you enable them again. | 1623869797161 |
remaining |
Optional[int] | ➖ | You can limit the number of requests a key can make. Once a key reaches 0 remaining requests, it will automatically be disabled and is no longer valid unless you update it. Learn more |
1000 |
refill |
Optional[models.V1MigrationsEnqueueKeysRefill] | ➖ | Unkey enables you to refill verifications for each key at regular intervals. | { "interval": "daily", "amount": 100 } |
ratelimit |
Optional[models.V1MigrationsEnqueueKeysRatelimit] | ➖ | Unkey comes with per-key fixed-window ratelimiting out of the box. | { "type": "fast", "limit": 10, "duration": 60000 } |
enabled |
Optional[bool] | ➖ | Sets if key is enabled or disabled. Disabled keys are not valid. | false |
environment |
Optional[str] | ➖ | Environments allow you to divide your keyspace. Some applications like Stripe, Clerk, WorkOS and others have a concept of "live" and "test" keys to give the developer a way to develop their own application without the risk of modifying real world resources. When you set an environment, we will return it back to you when validating the key, so you can handle it correctly. |