OpenAPI 3.1.02026-08-13140162205.6 KB

138b4ef69d2f

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.

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