Settings

Manage application settings

The Settings API allows administrators to retrieve and update application-wide configuration settings.

List settings

Returns the current application settings.

Requires superuser authentication.

Authorization · string · required

Admin authentication token

meta · object

Application metadata configuration

Show properties

appName · string

Application name (1-255 characters)

appURL · string

Application URL

senderName · string

Default email sender name (1-255 characters)

senderAddress · string

Default email sender address

hideControls · boolean

Whether to hide UI controls

logs · object

Logging configuration

Show properties

maxDays · number

Maximum days to keep logs (minimum: 0)

minLevel · number

Minimum log level to record

logIP · boolean

Whether to log IP addresses

logAuthId · boolean

Whether to log authenticated user IDs

smtp · object

SMTP email configuration

Show properties

enabled · boolean

Whether SMTP is enabled

host · string

SMTP server hostname (required when enabled)

port · number

SMTP server port (required when enabled, minimum: 0)

username · string

SMTP authentication username

password · string

SMTP authentication password (omitted in responses)

authMethod · string

SMTP AUTH method: PLAIN or LOGIN

tls · boolean

Whether to enforce TLS encryption

localName · string

Domain name or IP for EHLO/HELO exchange (defaults to “localhost”)

s3 · object

S3 storage configuration

Show properties

enabled · boolean

Whether S3 storage is enabled

bucket · string

S3 bucket name (required when enabled)

region · string

S3 region (required when enabled)

endpoint · string

S3 endpoint URL (required when enabled)

accessKey · string

S3 access key (required when enabled)

secret · string

S3 secret key (omitted in responses)

forcePathStyle · boolean

Whether to use path-style addressing

backups · object

Backups configuration

Show properties

cron · string

Cron expression for auto backups (e.g., ”* * * * *”). Leave empty to disable.

cronMaxKeep · number

Max number of cron backups to keep (required when cron is set, minimum: 1)

s3 · object

Optional S3 storage config for backups (same structure as main S3 config)

trustedProxy · object

Trusted proxy configuration

Show properties

headers · array

List of trusted header names to check

useLeftmostIP · boolean

Use leftmost IP from trusted headers (may be insecure with X-Forwarded-For)

rateLimits · object

Rate limiting configuration

Show properties

enabled · boolean

Whether rate limiting is enabled

rules · array

Array of rate limit rules

Show rule properties

label · string

Rule identifier (tag, path, or path prefix). Examples: test_a, users:create, *:create, /api/, POST /api/collections/

audience · string

Auth group: "" (all), "@guest" (guests only), or "@auth" (authenticated only)

duration · number

Interval in seconds to reset tokens (minimum: 1)

maxRequests · number

Max requests per duration (minimum: 1)

batch · object

Batch request configuration

Show properties

enabled · boolean

Whether batch requests are enabled

maxRequests · number

Max batch requests to execute (minimum: 0)

timeout · number

Max duration in seconds before cancelling batch transaction (minimum: 0)

maxBodySize · number

Max batch request body size in bytes (defaults to ~128MB if not set)

cURL

curl -X GET http://127.0.0.1:8090/api/settings \
  -H 'Authorization: TOKEN'

Update settings

Updates application settings. Only provided fields will be updated.

Requires superuser authentication.

Authorization · string · required

Admin authentication token

meta · object

Application metadata configuration

Show properties

meta.appName · string

Application name (1-255 characters)

meta.appURL · string

Application URL

meta.senderName · string

Default email sender name (1-255 characters)

meta.senderAddress · string

Default email sender address

meta.hideControls · boolean

Whether to hide UI controls

logs · object

Logging configuration

Show properties

logs.maxDays · number

Maximum days to keep logs (minimum: 0)

logs.minLevel · number

Minimum log level to record

logs.logIP · boolean

Whether to log IP addresses

logs.logAuthId · boolean

Whether to log authenticated user IDs

smtp · object

SMTP email configuration

Show properties

smtp.enabled · boolean

Whether SMTP is enabled

smtp.host · string

SMTP server hostname (required when enabled)

smtp.port · number

SMTP server port (required when enabled, minimum: 0)

smtp.username · string

SMTP authentication username

smtp.password · string

SMTP authentication password

smtp.authMethod · string

SMTP AUTH method: PLAIN or LOGIN

smtp.tls · boolean

Whether to enforce TLS encryption

smtp.localName · string

Domain name or IP for EHLO/HELO exchange

s3 · object

S3 storage configuration

Show properties

s3.enabled · boolean

Whether S3 storage is enabled

s3.bucket · string

S3 bucket name (required when enabled)

s3.region · string

S3 region (required when enabled)

s3.endpoint · string

S3 endpoint URL (required when enabled)

s3.accessKey · string

S3 access key (required when enabled)

s3.secret · string

S3 secret key (required when enabled)

s3.forcePathStyle · boolean

Whether to use path-style addressing

backups · object

Backups configuration

Show properties

backups.cron · string

Cron expression for auto backups

backups.cronMaxKeep · number

Max number of cron backups to keep (required when cron is set, minimum: 1)

backups.s3 · object

Optional S3 storage config for backups

trustedProxy · object

Trusted proxy configuration

Show properties

trustedProxy.headers · array

List of trusted header names

trustedProxy.useLeftmostIP · boolean

Use leftmost IP from trusted headers

rateLimits · object

Rate limiting configuration

Show properties

rateLimits.enabled · boolean

Whether rate limiting is enabled

rateLimits.rules · array

Array of rate limit rules

batch · object

Batch request configuration

Show properties

batch.enabled · boolean

Whether batch requests are enabled

batch.maxRequests · number

Max batch requests to execute

batch.timeout · number

Max duration in seconds before cancelling

batch.maxBodySize · number

Max batch request body size in bytes

Returns the updated settings object with the same structure as the GET endpoint.

cURL

curl -X PATCH http://127.0.0.1:8090/api/settings \
  -H 'Authorization: TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "meta": {
      "appName": "My App"
    },
    "logs": {
      "maxDays": 7
    }
  }'