4.7.1.4. Settings mixins

Parent API for working with system settings.

class axonius_api_client.api.system.settings_mixins.SettingsMixins(auth, **kwargs)

Bases: axonius_api_client.api.mixins.ModelMixins

Parent API for working with System Settings.

Parameters

auth (axonius_api_client.auth.models.Model) –

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, **kwargs)

Update the current settings for a section of system settings.

Parameters

• section (str) – name of section

• **kwargs – settings to update

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

__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.

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,