> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/pocketbase/pocketbase/llms.txt
> Use this file to discover all available pages before exploring further.
# Settings
> Manage application settings
The Settings API allows administrators to retrieve and update application-wide configuration settings.
## List settings
GET /api/settings
Returns the current application settings.
**Requires superuser authentication.**
Admin authentication token
Application metadata configuration
Application name (1-255 characters)
Application URL
Default email sender name (1-255 characters)
Default email sender address
Whether to hide UI controls
Logging configuration
Maximum days to keep logs (minimum: 0)
Minimum log level to record
Whether to log IP addresses
Whether to log authenticated user IDs
SMTP email configuration
Whether SMTP is enabled
SMTP server hostname (required when enabled)
SMTP server port (required when enabled, minimum: 0)
SMTP authentication username
SMTP authentication password (omitted in responses)
SMTP AUTH method: `PLAIN` or `LOGIN`
Whether to enforce TLS encryption
Domain name or IP for EHLO/HELO exchange (defaults to "localhost")
S3 storage configuration
Whether S3 storage is enabled
S3 bucket name (required when enabled)
S3 region (required when enabled)
S3 endpoint URL (required when enabled)
S3 access key (required when enabled)
S3 secret key (omitted in responses)
Whether to use path-style addressing
Backups configuration
Cron expression for auto backups (e.g., "\* \* \* \* \*"). Leave empty to disable.
Max number of cron backups to keep (required when cron is set, minimum: 1)
Optional S3 storage config for backups (same structure as main S3 config)
Trusted proxy configuration
List of trusted header names to check
Use leftmost IP from trusted headers (may be insecure with X-Forwarded-For)
Rate limiting configuration
Whether rate limiting is enabled
Array of rate limit rules
Rule identifier (tag, path, or path prefix). Examples: `test_a`, `users:create`, `*:create`, `/api/`, `POST /api/collections/`
Auth group: `""` (all), `"@guest"` (guests only), or `"@auth"` (authenticated only)
Interval in seconds to reset tokens (minimum: 1)
Max requests per duration (minimum: 1)
Batch request configuration
Whether batch requests are enabled
Max batch requests to execute (minimum: 0)
Max duration in seconds before cancelling batch transaction (minimum: 0)
Max batch request body size in bytes (defaults to \~128MB if not set)
```bash cURL theme={null}
curl -X GET http://127.0.0.1:8090/api/settings \
-H 'Authorization: TOKEN'
```
```javascript JavaScript theme={null}
const settings = await pb.settings.getAll();
```
## Update settings
PATCH /api/settings
Updates application settings. Only provided fields will be updated.
**Requires superuser authentication.**
Admin authentication token
Application metadata configuration
Application name (1-255 characters)
Application URL
Default email sender name (1-255 characters)
Default email sender address
Whether to hide UI controls
Logging configuration
Maximum days to keep logs (minimum: 0)
Minimum log level to record
Whether to log IP addresses
Whether to log authenticated user IDs
SMTP email configuration
Whether SMTP is enabled
SMTP server hostname (required when enabled)
SMTP server port (required when enabled, minimum: 0)
SMTP authentication username
SMTP authentication password
SMTP AUTH method: `PLAIN` or `LOGIN`
Whether to enforce TLS encryption
Domain name or IP for EHLO/HELO exchange
S3 storage configuration
Whether S3 storage is enabled
S3 bucket name (required when enabled)
S3 region (required when enabled)
S3 endpoint URL (required when enabled)
S3 access key (required when enabled)
S3 secret key (required when enabled)
Whether to use path-style addressing
Backups configuration
Cron expression for auto backups
Max number of cron backups to keep (required when cron is set, minimum: 1)
Optional S3 storage config for backups
Trusted proxy configuration
List of trusted header names
Use leftmost IP from trusted headers
Rate limiting configuration
Whether rate limiting is enabled
Array of rate limit rules
Batch request configuration
Whether batch requests are enabled
Max batch requests to execute
Max duration in seconds before cancelling
Max batch request body size in bytes
Returns the updated settings object with the same structure as the GET endpoint.
```bash cURL theme={null}
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
}
}'
```
```javascript JavaScript theme={null}
const settings = await pb.settings.update({
meta: {
appName: 'My App'
},
logs: {
maxDays: 7
}
});
```