const created = await unkey.keys.create({
	apiId:"api_7oKUUscTZy22jmVf9THxDA",
	prefix:"xyz",
	byteLength:16,
	ownerId:"chronark",
	meta:{
		hello: "world"
	},
	expires: 1686941966471,
	ratelimit: {
      type: "async",
      duration: 1000,
	  limit: 10,
	},
	remaining: 1000,
    refill: {
      interval: "daily",
      amount: 100
    },
  enabled: true
})

console.log(created)


{
  result: {
    key: "xyz_AS5HDkXXPot2MMoPHD8jnL"
    keyId: "key_YALWkHZaA4neUa1JJoXTAw"
	}
}

​
Request

apiId
string
required

Choose an API where this key should be created.

prefix
string

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

byteLength
int
default: 16

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 2128 possible combinations

ownerId
string

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.

name
string

A way to easily identify the key by giving it a name.

meta
object

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"
}
expires
int

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.

ratelimit
Object

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

remaining
number

Add how many times a key can be used, for example 100. Read more here

refill
Object

Unkey allows automatic refill on ‘remaining’ on a ‘daily’ or ‘monthly’ interval.

enabled
boolean

Sets if the key is enabled or disabled.

​
Response

result
key
string
required

The newly created api key

keyId
string
required

A unique identifier for this key. Use it later to update or revoke the key.

const created = await unkey.keys.create({
	apiId:"api_7oKUUscTZy22jmVf9THxDA",
	prefix:"xyz",
	byteLength:16,
	ownerId:"chronark",
	meta:{
		hello: "world"
	},
	expires: 1686941966471,
	ratelimit: {
      type: "async",
      duration: 1000,
	  limit: 10,
	},
	remaining: 1000,
    refill: {
      interval: "daily",
      amount: 100
    },
  enabled: true
})

console.log(created)


{
  result: {
    key: "xyz_AS5HDkXXPot2MMoPHD8jnL"
    keyId: "key_YALWkHZaA4neUa1JJoXTAw"
	}
}

Was this page helpful?

OverviewVerify