GET
/
v1
/
apis.listKeys

​
Changelog

DateChanges
Dec 06 2023Introduced endpoint
May 15 2024Return updatedAt timestamp
Aug 01 2024Return identities
Aug 01 2024Added 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
total
integer
required

The total number of keys for this api

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 APIDelete all keys of an API