4.6.5. System Settings -> GUI Settings¶

API for working with System Settings -> GUI Settings.

class axonius_api_client.api.system.settings_gui.SettingsGui(auth, **kwargs)[source]¶

Bases: axonius_api_client.api.system.settings_mixins.SettingsMixins

API for working with System Settings -> GUI Settings.

Parameters: auth (axonius_api_client.auth.models.Model) –

TITLE: str = 'GUI Settings'¶

_get()[source]¶

Direct API method to get the current system settings.

Return type: axonius_api_client.api.json_api.system_settings.SystemSettings

_update(new_config)[source]¶

Direct API method to update the system settings.

Parameters: new_config (dict) – new system settings to update
Return type: axonius_api_client.api.json_api.system_settings.SystemSettings

__init__(auth, **kwargs)¶

Mixins for API Models.

Parameters

auth (axonius_api_client.auth.models.Model) – object to use for auth and sending API requests
**kwargs – passed to _init()

__repr__()¶

Show info for this model object.

Return type: str

__str__()¶

Show info for this model object.

Return type: str

_init(**kwargs)¶: Post init method for subclasses to use for extra setup.

get()¶

Get the current system settings.

Return type: dict

get_section(section, full_config=False)¶

Get the current settings for a section of system settings.

Parameters

section (str) – name of section
full_config (bool) – return the full configuration

Return type

dict

get_sub_section(section, sub_section, full_config=False)¶

Get the current settings for a sub-section of a section of system settings.

Parameters

section (str) – name of section
sub_section (str) – name of sub section of section
full_config (bool) – return the full configuration

Return type

dict

update_section(section, check_unchanged=True, **kwargs)¶

Update the current settings for a section of system settings.

Parameters

section (str) – name of section
**kwargs – settings to update
check_unchanged (bool) –

Return type

dict

update_sub_section(section, sub_section, **kwargs)¶

Update the current settings for a sub-section of a section of system settings.

Parameters

section (str) – name of section
sub_section (str) – name of sub section of section
**kwargs – settings to update

Return type

dict

LOG: logging.Logger¶: Logger for this object.

auth¶: axonius_api_client.auth.models.Mixins authentication object.

http¶: axonius_api_client.http.Http client to use to send requests,