List keys for an API

GET

apis.listKeys

Changelog

Date	Changes
Dec 06 2023	Introduced endpoint
May 15 2024	Return updatedAt timestamp
Aug 01 2024	Return identities
Aug 01 2024	Added filtering by externalId

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

apiId

string

required

The id of the api to fetch

Minimum length: 1

limit

integer

default: 100

The maximum number of keys to return

Required range: 1 < x < 100

cursor

string

Use this to fetch the next page of results. A new cursor will be returned in the response if there are more results.

ownerId

string

deprecated

Deprecated. Use externalId instead.

Minimum length: 1

externalId

string

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

Minimum length: 1

decrypt

boolean | null

Decrypt and display the raw key. Only possible if the key was encrypted when generated.

revalidateKeysCache

boolean | null

default: false

EXPERIMENTAL

Skip the cache and fetch the keys from the database directly. When you're creating a key and immediately listing all keys to display them to your user, you might want to skip the cache to ensure the key is displayed immediately.

Response

200 - application/json

keys

object[]

required

keys.id

string

required

The id of the key

keys.start

string

required

The first few characters of the key to visually identify it

keys.workspaceId

string

required

The id of the workspace that owns the key

keys.apiId

string

The id of the api that this key is for

keys.name

string

The name of the key, give keys a name to easily identify their purpose

keys.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.

keys.meta

object

Any additional metadata you want to store with the key

keys.createdAt

integer

required

The unix timestamp in milliseconds when the key was created

keys.updatedAt

integer

The unix timestamp in milliseconds when the key was last updated

keys.expires

integer

The unix timestamp in milliseconds when the key will expire. If this field is null or undefined, the key is not expiring.

keys.remaining

integer

The number of requests that can be made with this key before it becomes invalid. If this field is null or undefined, the key has no request limit.

keys.refill

object

Unkey allows you to refill remaining verifications on a key on a regular interval.

keys.ratelimit

object

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

keys.roles

string[]

All roles this key belongs to

keys.permissions

string[]

All permissions this key has

keys.enabled

boolean

Sets if key is enabled or disabled. Disabled keys are not valid.

keys.plaintext

string

The key in plaintext

keys.identity

object

The identity of the key

total

integer

required

The total number of keys for this api. This is an approximation and may lag behind up to 5 minutes.

cursor

string

The cursor to use for the next page of results, if no cursor is returned, there are no more results

Was this page helpful?

Retrieve an API Delete all keys of an API

API Documentation

​Changelog

Authorizations

Query Parameters

Response

Changelog