Skip to main content
POST
Create an API key. The plain-text key is returned exactly once.

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 255
scopes
string[]
expires_at
string<date-time> | null

Response

Successful Response

Returned exactly once on creation. plain_text_key is never persisted and never returned again — the caller must store it immediately.

id
string<uuid>
required
name
string
required
key_prefix
string
required
scopes
string[]
required
is_active
boolean
required
last_used_at
string<date-time> | null
required
expires_at
string<date-time> | null
required
created_at
string<date-time>
required
plain_text_key
string
required