Sign in
API Keys

Create an API key (returns the plaintext once)

post/v1/orgs/{orgId}/api-keys/create

Path parameters

orgIdstring required

Request body

expiresInSecondsinteger

Optional server-side expiry, in seconds from now. When set (and > 0) the key stops authenticating after this many seconds, capping the leak window regardless of any client-side cleanup. Omitted or <= 0 means the key never expires (the default).

namestring required
scopesstring[]

Supported values: clusters:read, clusters:write, vms:read, vms:write, inference, and inference:endpoint:<id> for an enabled dedicated endpoint owned by the organization. An endpoint scope also adds the inference scope when it is omitted. clusters:read grants read access to the organization's resources, including VMs and pods, and clusters:write grants write access, including VM restart and API key creation. vms:read and vms:write are accepted for compatibility but grant nothing on their own, so each must be requested together with clusters:read or clusters:write respectively; a request with one but not the other returns 400.

Response

Created

createdAtstring required
idstring required
keystring required

Plaintext key, shown once

keyPrefixstring required
namestring required
organizationIdstring required

The organization this key is bound to. Every API key belongs to exactly one organization; keep this id alongside the key so callers can build org-scoped request paths without a separate lookup (GET /v1/whoami returns the same id for an existing key).

scopesstring[] required

Changes

No recorded changes to this endpoint across all 36 revisions of this API.