Skip to main content
POST
Create Consumer API Key
Creates a new personal API key for the authenticated consumer. The full secret is returned once in the response and cannot be retrieved again — store it securely. Each consumer can hold up to 5 active keys. Keys automatically expire after 90 days.

Parameters

string
required
A human-readable label for the key (e.g., “CI pipeline key”).

Responses

Authorizations

Authorization
string
header
required

JWT for user-initiated operations

Body

application/json
name
string
required

A human-readable label for the key

Response

API key created. The secret is shown only in this response.

key_id
string<uuid>
name
string

Human-readable label for the key

prefix
string

First 12 characters of the key, for display purposes

status
enum<string>
Available options:
active,
revoked
scopes
string[]

Permission scopes granted to this key

created_at
string<date-time>
expires_at
string<date-time>

Keys expire 90 days after creation

last_used_at
string<date-time>

Timestamp of the last request made with this key

secret
string

Full API key value (shown once)