system.general.update

Update System General Service Configuration.

UI configuration is not applied automatically. Call system.general.ui_restart to apply new UI settings (all HTTP connections will be aborted) or specify ui_restart_delay (in seconds) to automatically apply them after some small amount of time necessary you might need to receive the response for your settings update request.

If incorrect UI configuration is applied, you might loss API connectivity and won’t be able to fix the settings. To avoid that, specify rollback_timeout (in seconds). It will automatically roll back UI configuration to the previously working settings after rollback_timeout passes unless you call system.general.checkin in case the new settings were correct and no rollback is necessary.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: general_settings

general_settings

Type: object

SystemGeneralUpdateArgs parameters.

 No Additional Properties

Ui Certificate


Used to enable HTTPS access to the system. If ui_certificate is not configured on boot, it is automatically created by the system.

Type: integer
Type: null

Ui Httpsport

Type: integer

HTTPS port for the web UI.

Value must be greater or equal to 1 and lesser or equal to 65535

Ui Httpsredirect

Type: boolean

When set, makes sure that all HTTP requests are converted to HTTPS requests to better enhance security.

Ui Httpsprotocols

Type: array of enum (of string)

Array of TLS protocol versions enabled for HTTPS connections.

All items must be unique

No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "TLSv1"
  • "TLSv1.1"
  • "TLSv1.2"
  • "TLSv1.3"

Ui Port

Type: integer

HTTP port for the web UI.

Value must be greater or equal to 1 and lesser or equal to 65535

Ui Address

Type: array of string

A list of valid IPv4 addresses which the system will listen on.

Must contain a minimum of 1 items

No Additional Items
Each item of this array must be:
Type: string

Ui V6Address

Type: array of string

A list of valid IPv6 addresses which the system will listen on.

Must contain a minimum of 1 items

No Additional Items
Each item of this array must be:
Type: string

Ui Allowlist

Type: array of string

A list of IP addresses and networks that are allow to use API and UI. If this list is empty, then all IP addresses are allowed to use API and UI.

 No Additional Items
Each item of this array must be:
Type: string

Ui Consolemsg

Type: boolean

Whether to show console messages on the web UI.

Ui X Frame Options

Type: enum (of string)

X-Frame-Options header policy for web UI security.

Must be one of:
  • "SAMEORIGIN"
  • "DENY"
  • "ALLOW_ALL"

Kbdmap

Type: string

System keyboard layout mapping.

Timezone

Type: string

System timezone identifier.

Must be at least 1 characters long

Usage Collection


Whether usage data collection is enabled. null if not set.

Type: boolean
Type: null

Ds Auth

Type: boolean

Controls whether configured Directory Service users that are granted with Privileges are allowed to log in to the Web UI or use TrueNAS API.

Ui Restart Delay


Delay in seconds before restarting the UI after configuration changes. null to use default.

Type: integer
Type: null

Rollback Timeout


Timeout in seconds for automatic rollback of UI changes. null for no timeout.

Type: integer
Type: null

SystemGeneralEntry

Type: object

The updated system general configuration.

 No Additional Properties

Id

Type: integer

Unique identifier for the system general configuration.

Ui Certificate


Used to enable HTTPS access to the system. If ui_certificate is not configured on boot, it is automatically created by the system.

Type: object
Type: null

Ui Httpsport

Type: integer

HTTPS port for the web UI.

Value must be greater or equal to 1 and lesser or equal to 65535

Ui Httpsredirect

Type: boolean

When set, makes sure that all HTTP requests are converted to HTTPS requests to better enhance security.

Ui Httpsprotocols

Type: array of enum (of string)

Array of TLS protocol versions enabled for HTTPS connections.

All items must be unique

No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "TLSv1"
  • "TLSv1.1"
  • "TLSv1.2"
  • "TLSv1.3"

Ui Port

Type: integer

HTTP port for the web UI.

Value must be greater or equal to 1 and lesser or equal to 65535

Ui Address

Type: array of string

A list of valid IPv4 addresses which the system will listen on.

Must contain a minimum of 1 items

No Additional Items
Each item of this array must be:
Type: string

Ui V6Address

Type: array of string

A list of valid IPv6 addresses which the system will listen on.

Must contain a minimum of 1 items

No Additional Items
Each item of this array must be:
Type: string

Ui Allowlist

Type: array of string

A list of IP addresses and networks that are allow to use API and UI. If this list is empty, then all IP addresses are allowed to use API and UI.

 No Additional Items
Each item of this array must be:
Type: string

Ui Consolemsg

Type: boolean

Whether to show console messages on the web UI.

Ui X Frame Options

Type: enum (of string)

X-Frame-Options header policy for web UI security.

Must be one of:
  • "SAMEORIGIN"
  • "DENY"
  • "ALLOW_ALL"

Kbdmap

Type: string

System keyboard layout mapping.

Timezone

Type: string

System timezone identifier.

Must be at least 1 characters long

Usage Collection


Whether usage data collection is enabled. null if not set.

Type: boolean
Type: null

Wizardshown

Type: boolean

Whether the initial setup wizard has been shown.

Usage Collection Is Set

Type: boolean

Whether the usage collection preference has been explicitly set.

Ds Auth

Type: boolean

Controls whether configured Directory Service users that are granted with Privileges are allowed to log in to the Web UI or use TrueNAS API.


Required roles: SYSTEM_GENERAL_WRITE