v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

ApiKey

Create an API key

Create an API key for the current user; the secret is returned only once.

post/api/key/

cookie_namestring nullable

namestring nullable

Human-readable label to identify the key later.

descriptionstring nullable

Optional longer note describing what the key is used for.

{
  "name": "CI pipeline",
  "description": "Key used by the nightly data-sync job."
}

Successful Response

keystring required

The full secret token, in the form ak.<key_id>.<secret>. Shown only once at creation — store it securely; it cannot be retrieved again.

key_idstring required

Public identifier of the key. Safe to log and reference.

expires_atstring date-time nullable

UTC timestamp when the key expires, or null if it never expires.

{
  "key": "ak.a1b2c3d4.s3cr3t-value",
  "key_id": "a1b2c3d4",
  "expires_at": "2026-12-31T23:59:59Z"
}