Skip to main content
POST
Create a new API key for the calling tenant. Requires the admin scope on the calling key — non-admin keys can only read and use keys, not mint new ones. The plaintext is returned once in this response and never again; lose it and the only path forward is to delete and re-create.

Request body

CreateAPIKeyRequest
string
required
Human-readable label, e.g. ‘CI bot’ or ‘Slack integration’.
string[]
Allowed scopes. Empty list = full-access (back-compat). Otherwise must be a subset of: trigger:write, jobs:read, jobs:write, admin.
integer
Per-key request budget. Range 1..10000.

Response

CreateAPIKeyResponse
string
required
string
required
string
required
Plaintext API key — store it now. The platform only retains the SHA-256 hash; this is the one and only time the secret is exposed.
string
required
string[]
required
integer
required
string
required

Status codes