POST/v1/keys

Manage API keys

Create, list, and revoke per-user API keys. Disabled in LOCAL_MODE (auth is bypassed there, so keys are meaningless). All endpoints require an existing Bearer token. The full key value is shown ONLY in the create response — only the SHA-256 hash is stored.

Request body

Name	Type	Required	Description
name	string	required	Human-readable label (max 100 chars)

Example

bash

curl -X POST http://localhost:3000/v1/keys \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"CI pipeline"}'

Response

bash

{
  "success": true,
  "data": {
    "id": "k1a2b3c4-...",
    "name": "CI pipeline",
    "key": "nl_…",
    "prefix": "nl_abc12345",
    "createdAt": "2026-06-20T15:00:00Z"
  }
}

Try it

Live preview only works when the API is running on your machine.

Run docker compose up and the Try-It panel will become interactive. Until then, copy the curl example below.

Health probe