Skip to main content
GET
/
org
/
api_keys
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);
}
[
  {
    "id": "ckv9w8q2f000001l5r3j7k9m4",
    "name": "production",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "user-abc123",
      "email": "user@example.com",
      "name": "Jane Doe"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "deleted_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
​
status
enum<string>
default:active

Filter API keys by status. "active" returns keys that are not deleted (default; expired-but-not-deleted keys are still included), "deleted" returns only soft-deleted keys, "all" returns both.

Available options:
active,
deleted,
all
​
include_deleted
boolean
default:false

Deprecated: use status=all instead. When true, include deleted (soft-deleted) API keys in the results for audit purposes.

Response

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
​
expires_at
string<date-time> | null
required

When the API key expires

​
deleted_at
string<date-time> | null
required

When the API key was deleted (soft-deleted). Null for keys that have not been deleted.

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