Bulk updates application settings and returns the updated settings list.

Only superusers can perform this action.

Param	Type	Description
meta Application meta data (name, url, support email, etc.).
├─ Required appName	String	The app name.
├─ Required appUrl	String	The app public absolute url.
├─ Optional hideControls	Boolean	Hides the collection create and update controls from the Dashboard. Useful to prevent making accidental schema changes when in production environment.
├─ Required senderName	String	Transactional mails sender name.
├─ Required senderAddress	String	Transactional mails sender address.
logs App logger settings.
└─ Optional maxDays	Number	Max retention period. Set to 0 for no logs.
└─ Optional minLevel	Number	Specifies the minimum log persistent level. The default log levels are: -4: DEBUG 0: INFO 4: WARN 8: ERROR
└─ Optional logIP	Boolean	If enabled includes the client IP in the activity request logs.
└─ Optional logAuthId	Boolean	If enabled includes the authenticated record id in the activity request logs.
backups App data backups settings.
├─ Optional cron	String	Cron expression to schedule auto backups, e.g. `0 0 * * *`.
├─ Optional cronMaxKeep	Number	The max number of cron generated backups to keep before removing older entries.
└─ Optional s3	Object	S3 configuration (the same fields as for the S3 file storage settings).
smtp SMTP mail server settings.
├─ Optional enabled	Boolean	Enable the use of the SMTP mail server for sending emails.
├─ Required host	String	Mail server host (required if SMTP is enabled).
├─ Required port	Number	Mail server port (required if SMTP is enabled).
├─ Optional username	String	Mail server username.
├─ Optional password	String	Mail server password.
├─ Optional tls	Boolean	Whether to enforce TLS connection encryption. When false StartTLS command is send, leaving the server to decide whether to upgrade the connection or not).
├─ Optional authMethod	String	The SMTP AUTH method to use - PLAIN or LOGIN (used mainly by Microsoft). Default to PLAIN if empty.
└─ Optional localName	String	Optional domain name or (IP address) to use for the initial EHLO/HELO exchange. If not explicitly set, `localhost` will be used. Note that some SMTP providers, such as Gmail SMTP-relay, requires a proper domain name and and will reject attempts to use localhost.
s3 S3 compatible file storage settings.
├─ Optional enabled	Boolean	Enable the use of a S3 compatible storage.
├─ Required bucket	String	S3 storage bucket (required if enabled).
├─ Required region	String	S3 storage region (required if enabled).
├─ Required endpoint	String	S3 storage public endpoint (required if enabled).
├─ Required accessKey	String	S3 storage access key (required if enabled).
├─ Required secret	String	S3 storage secret (required if enabled).
└─ Optional forcePathStyle	Boolean	Forces the S3 request to use path-style addressing, e.g. "https://s3.amazonaws.com/BUCKET/KEY" instead of the default "https://BUCKET.s3.amazonaws.com/KEY".
batch Batch logs settings.
├─ Optional enabled	Boolean	Enable the batch Web APIs.
├─ Required maxRequests	Number	The maximum allowed batch request to execute.
├─ Required timeout	Number	The max duration in seconds to wait before cancelling the batch transaction.
└─ Optional maxBodySize	Number	The maximum allowed batch request body size in bytes. If not set, fallbacks to max ~128MB.
rateLimits Rate limiter settings.
├─ Optional enabled	Boolean	Enable the builtin rate limiter.
└─ Optional rules	{`Array`}	List of rate limit rules. Each rule have: `label` - the identifier of the rule. It could be a tag, complete path or path prerefix (when ends with `/`). `maxRequests` - the max allowed number of requests per duration. `duration` - specifies the interval (in seconds) per which to reset the counted/accumulated rate limiter tokens..
trustedProxy Trusted proxy headers settings.
├─ Optional headers	{`Array`}	List of explicit trusted header(s) to check.
└─ Optional useLeftmostIP	Boolean	Specifies to use the left-mostish IP from the trusted headers.

Param

Type

Description

meta
Application meta data (name, url, support email, etc.).

├─ Required appName

String

The app name.

├─ Required appUrl

String

The app public absolute url.

├─ Optional hideControls

Boolean

Hides the collection create and update controls from the Dashboard. Useful to prevent making accidental schema changes when in production environment.

├─ Required senderName

String

Transactional mails sender name.

├─ Required senderAddress

String

Transactional mails sender address.

logs
App logger settings.

└─ Optional maxDays

Number

Max retention period. Set to 0 for no logs.

└─ Optional minLevel

Number

Specifies the minimum log persistent level.
The default log levels are:

-4: DEBUG
0: INFO
4: WARN
8: ERROR

└─ Optional logIP

Boolean

If enabled includes the client IP in the activity request logs.

└─ Optional logAuthId

Boolean

If enabled includes the authenticated record id in the activity request logs.

backups
App data backups settings.

├─ Optional cron

String

Cron expression to schedule auto backups, e.g. 0 0 * * *.

├─ Optional cronMaxKeep

Number

The max number of cron generated backups to keep before removing older entries.

└─ Optional s3

Object

S3 configuration (the same fields as for the S3 file storage settings).

smtp
SMTP mail server settings.

├─ Optional enabled

Boolean

Enable the use of the SMTP mail server for sending emails.

├─ Required host

String

Mail server host (required if SMTP is enabled).

├─ Required port

Number

Mail server port (required if SMTP is enabled).

├─ Optional username

String

Mail server username.

├─ Optional password

String

Mail server password.

├─ Optional tls

Boolean

Whether to enforce TLS connection encryption.
When false StartTLS command is send, leaving the server to decide whether to upgrade the connection or not).

├─ Optional authMethod

String

The SMTP AUTH method to use - PLAIN or LOGIN (used mainly by Microsoft).
Default to PLAIN if empty.

└─ Optional localName

String

Optional domain name or (IP address) to use for the initial EHLO/HELO exchange.
If not explicitly set, localhost will be used.
Note that some SMTP providers, such as Gmail SMTP-relay, requires a proper domain name and and will reject attempts to use localhost.

s3
S3 compatible file storage settings.

├─ Optional enabled

Boolean

Enable the use of a S3 compatible storage.

├─ Required bucket

String

S3 storage bucket (required if enabled).

├─ Required region

String

S3 storage region (required if enabled).

├─ Required endpoint

String

S3 storage public endpoint (required if enabled).

├─ Required accessKey

String

S3 storage access key (required if enabled).

├─ Required secret

String

S3 storage secret (required if enabled).

└─ Optional forcePathStyle

Boolean

Forces the S3 request to use path-style addressing, e.g. "https://s3.amazonaws.com/BUCKET/KEY" instead of the default "https://BUCKET.s3.amazonaws.com/KEY".

batch
Batch logs settings.

├─ Optional enabled

Boolean

Enable the batch Web APIs.

├─ Required maxRequests

Number

The maximum allowed batch request to execute.

├─ Required timeout

Number

The max duration in seconds to wait before cancelling the batch transaction.

└─ Optional maxBodySize

Number

The maximum allowed batch request body size in bytes.
If not set, fallbacks to max ~128MB.

rateLimits
Rate limiter settings.

├─ Optional enabled

Boolean

Enable the builtin rate limiter.

└─ Optional rules

{`Array`}

List of rate limit rules. Each rule have:

label - the identifier of the rule.
It could be a tag, complete path or path prerefix (when ends with `/`).
maxRequests - the max allowed number of requests per duration.
duration - specifies the interval (in seconds) per which to reset the counted/accumulated rate limiter tokens..

trustedProxy
Trusted proxy headers settings.

├─ Optional headers

{`Array`}

List of explicit trusted header(s) to check.

└─ Optional useLeftmostIP

Boolean

Specifies to use the left-mostish IP from the trusted headers.

API details