OctoPrintClient.settings
- OctoPrintClient.settings.get(opts)
Retrieves the current settings.
- Arguments
opts (
object()
) – Additional options for the request
- Returns Promise
A jQuery Promise for the request’s response
- OctoPrintClient.settings.save(settings, opts)
Saves the provided
settings
.- Arguments
settings (
object()
) – The settings to saveopts (
object()
) – Additional options for the request
- Returns Promise
A jQuery Promise for the request’s response
- OctoPrintClient.settings.getPluginSettings(plugin, opts)
Retrieves the settings of the specified
plugin
.- Arguments
plugin (
string()
) – The plugin for which to retrieve the settingsopts (
object()
) – Additional options for the request
- Returns Promise
A jQuery Promise for the request’s response
- OctoPrintClient.settings.savePluginSettings(plugin, settings, opts)
Saves the
settings
for the specifiedplugin
.- Arguments
plugin (
string()
) – The plugin for which to save settingssettings (
object()
) – The settings to saveopts (
object()
) – Additional options for the request
- Returns Promise
A jQuery Promise for the request’s response
- OctoPrintClient.settings.generateApiKey(opts)
Generate a new system wide API key.
- Arguments
opts (
object()
) – Additional options for the request
- Returns Promise
A jQuery Promise for the request’s response
See also
- Settings API
The documentation of the underlying settings API.