Create an API key

POST

/api/admin/api-keys

The plaintext key is returned only once in the response.
Store it securely — it cannot be retrieved again.

Request

Authorization

API Key

Add parameter in cookie

next-auth.session-token

Example:

next-auth.session-token: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

API key created (plaintext key returned once)

Body

🟠400

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/admin/api-keys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "External Sync",
    "expiresAt": "2026-12-31T23:59:59.000Z"
}'

Response Example

201 - Success

{
    "id": "ak3c4d5e-f6a7-8901-cdef-123456789012",
    "name": "External Sync",
    "key": "fdm_live_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8",
    "keyPrefix": "fdm_live_a1b2c3",
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "createdAt": "2026-03-27T12:00:00.000Z"
}

Modified at 2026-03-27 22:49:45

List API keys

Revoke an API key