List API keys

List API keys for the authenticated organization. API keys are masked.

GET /org/api_keys

JavaScript

JavaScript

import Kernel from '@onkernel/sdk';

const client = new Kernel({
  apiKey: process.env['KERNEL_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const apiKey of client.apiKeys.list()) {
  console.log(apiKey.id);
}

200

[
  {
    "id": "ckv9w8q2f000001l5r3j7k9m4",
    "name": "production",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "user-abc123",
      "email": "[e-mail]",
      "name": "Jane Doe"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "project_id": "proj_abc123",
    "project_name": "Production",
    "masked_key": "sk_1234...abcd"
  }
]

Authorizations

Authorization · string · header · required

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

Query Parameters

limit · integer · default: 20

Maximum number of results to return

Required range: x <= 100

offset · integer · default: 0

Number of results to skip

query · string

Case-insensitive substring match against API key name, creator, and project. API key identifiers and masked keys match by exact value or prefix.

sort_by · enum<string> · default: created_at

Field to sort API keys by.

Available options: created_at, name, expires_at

sort_direction · enum<string> · default: desc

Sort direction for API keys.

Available options: asc, desc

Response

200

application/json

List of API keys

id · string · required

Unique API key identifier

Example:

"ckv9w8q2f000001l5r3j7k9m4"

name · string · required

API key name

Example:

"production"

created_at · string<date-time> · required

When the API key was created

created_by · object · required

Show child attributes

expires_at · string<date-time> | null · required

When the API key expires

project_id · string | null · required

Project identifier for project-scoped API keys. Null means org-wide.

Example:

"proj_abc123"

project_name · string | null · required

Project name for project-scoped API keys. Null means the key is org-wide or the project name is unavailable.

Example:

"Production"

masked_key · string · required

Masked version of the API key

Example:

"sk_1234...abcd"