List Keys

Get a list of keys belonging to an API

Request

const { result, error } = await unkey.apis.listKeys({
  apiId: "api_QUGih1EMtBy9eSSf3vujmF",
  limit: 100,
})

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)

Response

{
  "result": {
    "keys": [
    {
      "id": "key_HPnfviesBEKHnZBFFiY4fg",
      "apiId": "api_QUGih1EMtBy9eSSf3vujmF",
      "workspaceId": "ws_o17fS1LvwtRswPdncAcUM",
      "start": "key_Crg",
      "createdAt": 1687642066782,
      "expires": null,
      "ratelimit": {
        "type": "fast",
        "limit": 11,
        "refillRate": 11,
        "refillInterval": 11
      }
    },
    ...
  ],
  "total": 4
  }
}

Request

apiId · string · required

The ID of the api you want to retrieve.

limit · int · default: 100

Limit the number of returned keys, the maximum is 100.

offset · int · default: 0

Specify an offset for pagination.

Example: An offset of 4 will skip the first 4 keys and return keys starting at the 5th position.

ownerId · string

Filter by ownerId.

If provided, this will only return keys where the ownerId matches.

Response

result

Hide properties

keys · Array · required

Show child attributes

id · string · required

The unique key id, use this to reference the key directly when fetching or revoking.

apiId · string · required

The API id where this key belongs to.

workspaceId · string · required

The workspace id where this key belongs to.

start · string · required

The first few characters of the key. This can be useful when displaying it your users, so they can match it.

name · string

The name you gave this key.

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.

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

createdAt · int · required

When the key was created, unix timestamp in milliseconds.

expires · int

If set, this is when the key ceases to exist, unix timestamp in milliseconds. Once keys expire they will automatically be deleted and are no longer valid.

remaining · int

How many more times this key can be used.

ratelimit · Object

The ratelimit of this key, if configured.

Show properties

type · string · default: "fast" · required

Either fast or consistent.

Read more here

limit · int · required

The total amount of burstable requests.

refillRate · int · required

How many tokens to refill during each refillInterval

refillInterval · int · required

Determines the speed at which tokens are refilled.

In milliseconds

total · int · required

How many keys in total there are in this API. Useful to paginate through this endpoint.