apiKeys.list() - Mesa Docs

API keys are deprecated. The SDK can manage them for CLI and direct backend integrations, but cannot use them as its own client credential. New integrations should use private keys instead.

List API keys visible to the caller. Secret key values are never returned. Required scope: admin

const keys = await mesa.apiKeys.list();

for (const key of keys.api_keys) {
  console.log(key.id, key.name, key.scopes);
}

Response

string | null

Cursor for the next page, or null when no more results remain.

boolean

Whether another page of results is available.

ApiKeyListItem[]

API key summaries.

ApiKeyListItem

string

API key ID.

string | null

API key name, or null when unnamed.

string[]

Scopes granted to this key.

string[] | null

Repository allowlist, or null when the key is not repo-scoped.

Record<string, unknown> | null

Additional API key metadata, or null when absent.

Record<string, string>

User-defined API key tags.

string | null

Last use time, or null when the key has not been used.

string | null

Expiration time, or null when the key does not expire.

string | null

Revocation time, or null when the key is active.

string

Creation time.

Raw filters

The high-level method currently accepts only org. Use mesa.raw.listApiKeys(...) for generated filters such as query, status, scope, repo_id, cursor, and limit.

​Response

​ApiKeyListItem

​Raw filters

Response

ApiKeyListItem

Raw filters