Internal API ReferenceΒΆ
- octoprint.access.users
- octoprint.access.users.AnonymousUser
- octoprint.access.users.CorruptUserStorage
- octoprint.access.users.InternalUser
- octoprint.access.users.InvalidUsername
- octoprint.access.users.SessionUser
- octoprint.access.users.UnknownRole
- octoprint.access.users.UnknownUser
- octoprint.access.users.User
- octoprint.access.users.UserAlreadyExists
- octoprint.cli
- octoprint.cli.dev
- octoprint.cli.plugins
- octoprint.cli.server
- octoprint.filemanager
- octoprint.filemanager.analysis
- octoprint.filemanager.destinations
- octoprint.filemanager.storage
- octoprint.filemanager.storage.StorageInterface
- add_file
- add_folder
- analysis_backlog
- available_name
- canonicalize
- copy_file
- copy_folder
- file_exists
- file_in_path
- folder_exists
- get_additional_metadata
- get_hash
- get_lastmodified
- get_metadata
- get_size
- has_analysis
- join_path
- list_files
- move_file
- move_folder
- path_in_storage
- path_on_disk
- read_file
- remove_additional_metadata
- remove_file
- remove_folder
- sanitize
- sanitize_name
- sanitize_path
- set_additional_metadata
- split_path
- validate_additional_metadata
- octoprint.filemanager.storage.StorageInterface
- octoprint.filemanager.storage.local
- octoprint.filemanager.storage.local.LocalFileStorage
- add_file
- add_folder
- analysis_backlog
- canonicalize
- copy_file
- copy_folder
- file_exists
- file_in_path
- folder_exists
- get_additional_metadata
- get_hash
- get_lastmodified
- get_metadata
- get_size
- has_analysis
- join_path
- move_file
- move_folder
- path_in_storage
- path_on_disk
- read_file
- remove_additional_metadata
- remove_file
- remove_folder
- sanitize
- sanitize_name
- sanitize_path
- set_additional_metadata
- split_path
- validate_additional_metadata
- octoprint.filemanager.storage.local.LocalFileStorage
- octoprint.filemanager.storage.printer
- octoprint.filemanager.storage.printer.PrinterFileStorage
- add_file
- add_folder
- available_name
- copy_file
- copy_folder
- file_exists
- file_in_path
- folder_exists
- get_additional_metadata
- get_hash
- get_lastmodified
- get_metadata
- get_size
- has_analysis
- join_path
- move_file
- move_folder
- path_in_storage
- path_on_disk
- read_file
- remove_additional_metadata
- remove_file
- remove_folder
- sanitize
- sanitize_name
- sanitize_path
- set_additional_metadata
- split_path
- validate_additional_metadata
- octoprint.filemanager.storage.printer.PrinterFileStorage
- octoprint.filemanager.util
- octoprint.plugin
- octoprint.plugin.core
- octoprint.plugin.core.PluginManager
- disable_plugin
- enable_plugin
- get_filtered_implementations
- get_helpers
- get_hooks
- get_implementations
- get_plugin
- get_plugin_info
- has_any_of_hooks
- has_any_of_mixins
- has_obsolete_hooks
- has_restart_needing_hooks
- has_restart_needing_implementation
- hook_matches_hooks
- is_obsolete_hook
- is_plugin_marked
- is_restart_needing_hook
- is_restart_needing_plugin
- mark_plugin
- plugin_hooks
- plugins
- register_message_receiver
- reload_plugins
- send_plugin_message
- unregister_message_receiver
- octoprint.plugin.core.PluginInfo
- Parameters
- author
- blocklisted
- bundled
- check
- description
- disable
- disabling_discouraged
- enable
- enabled
- flags
- forced_disabled
- get_hook
- get_implementation
- helpers
- hidden
- hooks
- implementation
- incompatible
- invalid_syntax
- license
- load
- loaded
- long_str
- looks_like_plugin
- managable
- name
- needs_restart
- origin
- parsed_metadata
- privacypolicy
- pythoncompat
- unload
- url
- validate
- version
- octoprint.plugin.core.Plugin
- octoprint.plugin.core.RestartNeedingPlugin
- octoprint.plugin.core.SortablePlugin
- octoprint.plugin.core.PluginManager
- octoprint.plugin.types
- octoprint.printer
- octoprint.printer.CommonPrinterMixin
- cancel_print
- change_tool
- commands
- connect
- disconnect
- extrude
- feed_rate
- flow_rate
- get_current_data
- get_current_job
- get_current_temperatures
- get_error
- get_state_id
- get_state_string
- get_temperature_history
- home
- is_cancelling
- is_closed_or_error
- is_error
- is_finishing
- is_operational
- is_paused
- is_pausing
- is_printing
- is_ready
- is_resuming
- is_storage_mounted
- job_on_hold
- jog
- log_lines
- mount_storage
- pause_print
- repair_communication
- resume_print
- script
- set_job_on_hold
- set_temperature
- set_temperature_offset
- start_print
- toggle_pause_print
- unmount_storage
- valid_axes
- valid_heater_regex
- valid_heater_regex_no_current
- valid_tool_regex
- octoprint.printer.ConnectedPrinterMixin
- octoprint.printer.PrinterFilesMixin
- octoprint.printer.PrinterMixin
- octoprint.printer.PrinterCallback
- octoprint.printer.CommonPrinterMixin
- octoprint.printer.connection
- octoprint.printer.connection.ConnectedPrinter
- octoprint.printer.connection.ConnectedPrinterRegistration
- octoprint.printer.connection.ConnectedPrinterState
- octoprint.printer.connection.ERROR_STATES
- octoprint.printer.connection.CLOSED_STATES
- octoprint.printer.connection.OPERATIONAL_STATES
- octoprint.printer.connection.PRINTING_STATES
- octoprint.printer.estimation
- octoprint.printer.job
- octoprint.printer.profile
- octoprint.schema
- octoprint.schema.config
- octoprint.schema.config.Config
- octoprint.schema.config.access_control.AccessControlConfig
- Config
- addRemoteUsers
- autologinAs
- autologinHeadsupAcknowledged
- autologinLocal
- checkBasicAuthenticationPassword
- defaultReauthenticationTimeout
- groupManager
- groupfile
- localNetworks
- permissionManager
- remoteGroupsHeader
- remoteGroupsMapping
- remoteUserHeader
- salt
- sessionStaleAfter
- trustBasicAuthentication
- trustRemoteGroups
- trustedAuthProxies
- userManager
- userfile
- octoprint.schema.config.api.ApiConfig
- octoprint.schema.config.appearance.AppearanceConfig
- octoprint.schema.config.appearance.ColorEnum
- octoprint.schema.config.appearance.ComponentConfig
- octoprint.schema.config.appearance.ComponentDisabledConfig
- octoprint.schema.config.appearance.ComponentOrderConfig
- octoprint.schema.config.appearance.ThumbnailAlignmentEnum
- octoprint.schema.config.appearance.ThumbnailConfig
- octoprint.schema.config.controls.CustomControl
- octoprint.schema.config.controls.CustomControlContainer
- octoprint.schema.config.controls.CustomControlInput
- octoprint.schema.config.controls.CustomControlSlider
- octoprint.schema.config.controls.LayoutEnum
- octoprint.schema.config.devel.DevelCacheConfig
- octoprint.schema.config.devel.DevelConfig
- octoprint.schema.config.devel.DevelWebassetsConfig
- octoprint.schema.config.devel.StylesheetEnum
- octoprint.schema.config.estimation.EstimationConfig
- octoprint.schema.config.estimation.PrintTimeEstimationConfig
- octoprint.schema.config.events.EventSubscription
- octoprint.schema.config.events.EventsConfig
- octoprint.schema.config.events.SubscriptionTypeEnum
- octoprint.schema.config.feature.FeatureConfig
- Config
- autoUppercaseBlocklist
- enableDragDropUpload
- enforceReallyUniversalFilenames
- fileDeleteConfirmation
- g90InfluencesExtruder
- keyboardControl
- modelSizeDetection
- notifySuppressedCommands
- pollWatched
- printCancelConfirmation
- printStartConfirmation
- rememberFileFolder
- sdSupport
- temperatureGraph
- uploadOverwriteConfirmation
- octoprint.schema.config.feature.SuppressionNotificationLevelEnum
- octoprint.schema.config.folder.FolderConfig
- octoprint.schema.config.gcode_analysis.GcodeAnalysisConfig
- octoprint.schema.config.gcode_analysis.RunAtEnum
- octoprint.schema.config.plugins.PluginsConfig
- octoprint.schema.config.printer_parameters.PrinterParametersConfig
- octoprint.schema.config.printer_profiles.PrinterProfilesConfig
- octoprint.schema.config.scripts.GcodeScriptsConfig
- octoprint.schema.config.scripts.ScriptsConfig
- octoprint.schema.config.server.CommandsConfig
- octoprint.schema.config.server.CookiesConfig
- octoprint.schema.config.server.DiskspaceConfig
- octoprint.schema.config.server.IpCheckConfig
- octoprint.schema.config.server.OnlineCheckConfig
- octoprint.schema.config.server.PluginBlocklistConfig
- octoprint.schema.config.server.PreemptiveCacheConfig
- octoprint.schema.config.server.PythonEolCheckConfig
- octoprint.schema.config.server.PythonEolEntry
- octoprint.schema.config.server.ReverseProxyConfig
- octoprint.schema.config.server.SameSiteEnum
- octoprint.schema.config.server.ServerConfig
- octoprint.schema.config.server.UploadsConfig
- octoprint.schema.config.slicing.SlicingConfig
- octoprint.schema.config.system.ActionConfig
- octoprint.schema.config.system.SystemConfig
- octoprint.schema.config.temperature.TemperatureConfig
- octoprint.schema.config.temperature.TemperatureProfile
- octoprint.schema.config.terminalfilters.TerminalFilterEntry
- octoprint.schema.config.webcam.RenderAfterPrintEnum
- octoprint.schema.config.webcam.TimelapseConfig
- octoprint.schema.config.webcam.TimelapseOptions
- octoprint.schema.config.webcam.TimelapseTypeEnum
- octoprint.schema.config.webcam.WebcamConfig
- octoprint.schema.webcam
- octoprint.server
- octoprint.server.util
- octoprint.server.util.corsRequestHandler
- octoprint.server.util.corsResponseHandler
- octoprint.server.util.csrfRequestHandler
- octoprint.server.util.csrfResponseHandler
- octoprint.server.util.get_api_key
- octoprint.server.util.get_user_for_apikey
- octoprint.server.util.get_user_for_authorization_header
- octoprint.server.util.get_user_for_remote_user_header
- octoprint.server.util.has_permissions
- octoprint.server.util.noCachingExceptGetResponseHandler
- octoprint.server.util.noCachingResponseHandler
- octoprint.server.util.optionsAllowOrigin
- octoprint.server.util.require_fresh_login_with
- octoprint.server.util.require_login
- octoprint.server.util.require_login_with
- octoprint.server.util.validate_local_redirect
- octoprint.server.util.flask
- octoprint.server.util.flask.LessSimpleCache
- octoprint.server.util.flask.OctoPrintFlaskRequest
- octoprint.server.util.flask.OctoPrintFlaskResponse
- octoprint.server.util.flask.OctoPrintJsonProvider
- octoprint.server.util.flask.OctoPrintSessionInterface
- octoprint.server.util.flask.PluginAssetResolver
- octoprint.server.util.flask.PrefixAwareJinjaEnvironment
- octoprint.server.util.flask.ReverseProxyInfo
- octoprint.server.util.flask.SettingsCheckUpdater
- octoprint.server.util.flask.check_lastmodified
- octoprint.server.util.flask.firstrun_only_access
- octoprint.server.util.flask.get_cookie_suffix
- octoprint.server.util.flask.get_flask_user_from_request
- octoprint.server.util.flask.make_api_error
- octoprint.server.util.flask.make_text_response
- octoprint.server.util.flask.no_firstrun_access
- octoprint.server.util.flask.permission_and_fresh_credentials_validator
- octoprint.server.util.flask.permission_validator
- octoprint.server.util.flask.redirect_to_tornado
- octoprint.server.util.flask.require_credentials_checked_recently
- octoprint.server.util.flask.restricted_access
- octoprint.server.util.sockjs
- octoprint.server.util.tornado
- octoprint.server.util.tornado.CorsSupportMixin
- octoprint.server.util.tornado.CustomHTTP1Connection
- octoprint.server.util.tornado.CustomHTTP1ConnectionParameters
- octoprint.server.util.tornado.CustomHTTP1ServerConnection
- octoprint.server.util.tornado.CustomHTTPServer
- octoprint.server.util.tornado.DeprecatedEndpointHandler
- octoprint.server.util.tornado.DynamicZipBundleHandler
- octoprint.server.util.tornado.GeneratingDataHandler
- octoprint.server.util.tornado.GlobalHeaderTransform
- octoprint.server.util.tornado.LargeResponseHandler
- octoprint.server.util.tornado.RequestlessExceptionLoggingMixin
- octoprint.server.util.tornado.StaticDataHandler
- octoprint.server.util.tornado.StaticZipBundleHandler
- octoprint.server.util.tornado.StorageBulkDownloadHandler
- octoprint.server.util.tornado.StorageFileDownloadHandler
- octoprint.server.util.tornado.StorageThumbnailDownloadHandler
- octoprint.server.util.tornado.SystemInfoBundleHandler
- octoprint.server.util.tornado.UploadStorageFallbackHandler
- octoprint.server.util.tornado.UrlProxyHandler
- octoprint.server.util.tornado.WebcamSnapshotHandler
- octoprint.server.util.tornado.WsgiInputContainer
- octoprint.server.util.tornado.access_validation_factory
- octoprint.server.util.tornado.enable_per_message_deflate_extension
- octoprint.server.util.tornado.fix_json_encode
- octoprint.server.util.tornado.fix_tornado_xheader_handling
- octoprint.server.util.tornado.fix_websocket_check_origin
- octoprint.server.util.tornado.path_validation_factory
- octoprint.settings
- octoprint.settings.default_settings
- octoprint.settings.valid_boolean_trues
- octoprint.settings.settings
- octoprint.settings.Settings
- OVERLAY_KEY
- add_overlay
- add_path_update_callback
- backup
- checkBaseFolder
- clean_temps
- config
- config_hash
- config_yaml
- effective
- effective_hash
- effective_yaml
- get
- getBaseFolder
- getBoolean
- getFloat
- getInt
- has
- last_modified
- last_modified_or_made_dirty
- listScripts
- load
- loadScript
- load_overlay
- load_overlays
- remove
- remove_overlay
- remove_path_update_callback
- sanity_check_folders
- save
- saveScript
- set
- setBaseFolder
- setBoolean
- setFloat
- setInt
- warn_about_risky_settings
- octoprint.slicing
- octoprint.slicing.exceptions
- octoprint.slicing.exceptions.SlicingException
- octoprint.slicing.exceptions.SlicingCancelled
- octoprint.slicing.exceptions.SlicerException
- octoprint.slicing.exceptions.UnknownSlicer
- octoprint.slicing.exceptions.SlicerNotConfigured
- octoprint.slicing.exceptions.ProfileException
- octoprint.slicing.exceptions.UnknownProfile
- octoprint.slicing.exceptions.ProfileAlreadyExists
- octoprint.util
- octoprint.util.CaseInsensitiveSet
- octoprint.util.DefaultOrderedDict
- octoprint.util.PrependableQueue
- octoprint.util.RepeatedTimer
- octoprint.util.ResettableTimer
- octoprint.util.TypeAlreadyInQueue
- octoprint.util.TypedQueue
- octoprint.util.chunks
- octoprint.util.count
- octoprint.util.deprecated
- octoprint.util.deserialize
- octoprint.util.dict_contains_all_keys
- octoprint.util.dict_contains_any_keys
- octoprint.util.dict_contains_keys
- octoprint.util.dict_filter
- octoprint.util.dict_flatten
- octoprint.util.dict_merge
- octoprint.util.dict_minimal_mergediff
- octoprint.util.dict_sanitize
- octoprint.util.fallback_dict
- octoprint.util.filter_non_ascii
- octoprint.util.get_bom
- octoprint.util.get_class
- octoprint.util.get_exception_string
- octoprint.util.get_formatted_datetime
- octoprint.util.get_formatted_size
- octoprint.util.get_formatted_timedelta
- octoprint.util.get_fully_qualified_classname
- octoprint.util.is_allowed_file
- octoprint.util.pending_deprecation
- octoprint.util.pp
- octoprint.util.serialize
- octoprint.util.to_bytes
- octoprint.util.to_unicode
- octoprint.util.variable_deprecated
- octoprint.util.variable_pending_deprecation
- octoprint.util.commandline
- octoprint.util.json
- octoprint.util.platform
- octoprint.util.version
- octoprint.util.version.get_comparable_version
- octoprint.util.version.get_octoprint_version
- octoprint.util.version.get_octoprint_version_string
- octoprint.util.version.get_package_version
- octoprint.util.version.get_python_version
- octoprint.util.version.get_python_version_string
- octoprint.util.version.is_octoprint_compatible
- octoprint.util.version.is_prerelease
- octoprint.util.version.is_python_compatible
- octoprint.util.version.is_release
- octoprint.util.version.is_released_octoprint_version
- octoprint.util.version.is_stable
- octoprint.util.version.is_stable_octoprint_version
- octoprint.util.version.is_version_compatible
- octoprint.util.version.normalize_version
- octoprint.util.version.parse_specifier
- octoprint.util.version.safe_get_package_version