Skip to content
ReflexDB

Create API key

POST
/databases/{dbId}/api-keys
 
curl --request POST \
  --url https://api.reflexdb.cloud/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "expiresAt": "2026-04-15T12:00:00Z" }'

Generates a new HMAC-signed API key for the instance. The raw key (rxk_...) is returned once in the key field — store it immediately.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
dbId
required
string format: uuid

Database ID

Request Body required

Section titled “Request Body required ”
Media type application/json
CreateApiKeyBody
object
name
required
string
>= 1 characters <= 100 characters
expiresAt

ISO 8601 expiry — key is rejected after this time

string format: date-time
Example generated
{
  "name": "example",
  "expiresAt": "2026-04-15T12:00:00Z"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Newly created instance API key — raw key shown once, cannot be retrieved again

Media type application/json
CreatedApiKey

Newly created instance API key — raw key shown once, cannot be retrieved again

object
id
required
string format: uuid
databaseId
required
string format: uuid
name
required
string
keyPrefix
required

Non-secret key identifier used for indexed revocation lookup

string
lastUsedAt
string format: date-time
nullable
expiresAt
string format: date-time
nullable
createdAt
required
string format: date-time
revokedAt
string format: date-time
nullable
key
required

Full API key. Format: rxk_.. Present only on creation.

string
Example generated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "databaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "keyPrefix": "example",
  "lastUsedAt": "2026-04-15T12:00:00Z",
  "expiresAt": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "revokedAt": "2026-04-15T12:00:00Z",
  "key": "example"
}

403

Section titled “403 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}