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

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: general_settings

general_settings

Type: object
No Additional Properties

ui_certificate

Ui Certificate

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

Any of

• Option 1
• Option 2

Type: integer

Type: null

ui_httpsport

Ui Httpsport

Type: integer

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

ui_httpsredirect

Ui Httpsredirect

Type: boolean

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

ui_httpsprotocols

Ui Httpsprotocols

Type: array of enum (of string)

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

Ui Port

Type: integer

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

ui_address

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

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

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

No Additional Items

Each item of this array must be:

Type: string

ui_consolemsg

Ui Consolemsg

Type: boolean

ui_x_frame_options

Ui X Frame Options

Type: enum (of string)

Must be one of:

• "SAMEORIGIN"
• "DENY"
• "ALLOW_ALL"

kbdmap

Kbdmap

Type: string

timezone

Timezone

Type: string

Must be at least 1 characters long

usage_collection

Usage Collection

Any of

• Option 1
• Option 2

Type: boolean

Type: null

ds_auth

Ds Auth

Type: boolean

Controls whether configured Directory Service users that are granted with Privileges are allowed to log in to the

ui_restart_delay

Ui Restart Delay

Any of

• Option 1
• Option 2

Type: integer

Type: null

rollback_timeout

Rollback Timeout

Any of

• Option 1
• Option 2

Type: integer

Type: null

Return value

SystemGeneralEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

ui_certificate Required

Ui Certificate

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

Any of

• Option 1
• Option 2

Type: object

Type: null

ui_httpsport Required

Ui Httpsport

Type: integer

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

ui_httpsredirect Required

Ui Httpsredirect

Type: boolean

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

ui_httpsprotocols Required

Ui Httpsprotocols

Type: array of enum (of string)

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 Required

Ui Port

Type: integer

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

ui_address Required

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 Required

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 Required

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

No Additional Items

Each item of this array must be:

Type: string

ui_consolemsg Required

Ui Consolemsg

Type: boolean

ui_x_frame_options Required

Ui X Frame Options

Type: enum (of string)

Must be one of:

• "SAMEORIGIN"
• "DENY"
• "ALLOW_ALL"

kbdmap Required

Kbdmap

Type: string

timezone Required

Timezone

Type: string

Must be at least 1 characters long

usage_collection Required

Usage Collection

Any of

• Option 1
• Option 2

Type: boolean

Type: null

wizardshown Required

Wizardshown

Type: boolean

usage_collection_is_set Required

Usage Collection Is Set

Type: boolean

ds_auth Required

Ds Auth

Type: boolean

Controls whether configured Directory Service users that are granted with Privileges are allowed to log in to the

Required roles: SYSTEM_GENERAL_WRITE