create_key

Choose an API where this key should be created.

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 automtically added if you are defining a prefix, for example: "prefix": "abc" will result in a key like abc_xxxxxxxxx

The bytelength used to generate your key determines its entropy as well as its length. Higher is better, but keys become longer and more annoying to handle.

The default is 16 bytes, or 2¹²⁸ possible combinations

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.

This is a place for dynamic meta data, anything that feels useful for you should go here

Example:

{
  "billingTier": "PRO",
  "trialEnds": "2023-06-16T17:16:37.161Z"
}

You can auto expire keys by providing a unix timestamp in milliseconds.

Once keys expire they will automatically be deleted and are no longer valid.

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

Optionally limit the number of times a key can be used. This is different from time-based expiration using expires.

Example:

"remaining": 10

The created key can be verified successfully 10 times, afterwards it is invalidated automatically.

Read more here

The newly created api key

A unique id to reference this key for updating or revoking. This id can not be used to verify the key.