Skip to main content
POST
Mint a tenant API key

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Body

application/json

POST /v1/api-keys — mint one tenant credential.

key_name
string
required

What the key will be called. Unique per tenant.

description
string | null

Free text beside it, for whoever reads the list in six months.

Response

Created

The one response that reveals a key's plaintext.

created_at
integer<int64>
required

When it was minted.

id
string
required

The key's identifier, which every later call addresses it by.

key
string
required

The credential itself. Shown once and never stored in this shape.

key_name
string
required

What it is called.