Sign in

v1

latestOpenAPI 3.0.32026-07-24707482.9 KB
API Keys

Mint a new API key for the authenticated user

Mints an Overledger-issued API key. The response carries the raw key ONCE in the apiKey field — it is unrecoverable afterwards. This route accepts header-token auth only (a URL/header API key can never mint, list, or revoke keys).

post/users/me/api-keys

Request body

labelstring required

Human-readable name for the key, e.g. "CI key".

scopesApiKeyScope[]

Scopes to grant. Defaults to ["rpc"] when omitted.

expiresAtstring date-time

Optional ISO-8601 expiry. Must be in the future; absent = no expiry.

Example request

{
  "label": "CI key",
  "scopes": [
    "rpc"
  ]
}

Response

Key minted — apiKey shown once.

apiKeystring required

The full raw key — shown only once at creation.

keyIdstring required
labelstring required
scopesApiKeyScope[] required
createdAtstring date-time required
lastUsedAtstring date-time
expiresAtstring date-time

Example response

{
  "apiKey": "fk_abc123def456.s3cr3tValue...",
  "scopes": [
    "rpc"
  ]
}