Skip to content
You are looking at a work in progress OctoPrint documentation rewrite that may be incomplete and/or contain errors. The current official documentation can be found
at docs.octoprint.org
.
OctoPrint
octoprint.server.api
Initializing search
OctoPrint/OctoPrint
Home
User Guide
Plugin Development Guide
Core Development Guide
Code Reference
OctoPrint
OctoPrint/OctoPrint
Home
User Guide
User Guide
Features
Features
Access control
Action commands
At commands
Custom controls
GCode scripts
Plugins
Safe mode
Configuration
Configuration
Main configuration: config.yaml
Logging configuration: logging.yaml
CLI
A YAML primer
Plugin Development Guide
Plugin Development Guide
Tutorial
Plugin concepts
Plugin concepts
Lifecycle
Control properties
Mixins
Hooks
Helpers
Core Development Guide
Core Development Guide
Code Reference
Code Reference
octoprint
octoprint
_version
access
access
groups
permissions
users
cli
cli
analysis
client
common
config
dev
plugins
server
systeminfo
timelapse
user
daemon
environment
events
filemanager
filemanager
analysis
destinations
storage
util
logging
logging
filters
handlers
plugin
plugin
core
types
plugins
plugins
action_command_notification
action_command_prompt
announcements
appkeys
backup
classicwebcam
corewizard
corewizard
subwizards
discovery
errortracking
eventmanager
gcodeviewer
logging
pluginmanager
pluginmanager
exceptions
softwareupdate
softwareupdate
cli
exceptions
scripts
scripts
update-octoprint
updaters
updaters
pip
python_updater
single_file_plugin
sleep_a_bit
update_script
util
version_checks
version_checks
always_current
bitbucket_commit
commandline
git_commit
github_commit
github_release
httpheader
jsondata
never_current
pypi_release
python_checker
tracking
virtual_printer
virtual_printer
virtual
printer
printer
estimation
profile
standard
schema
schema
config
config
access_control
api
appearance
controls
devel
estimation
events
feature
folder
gcode_analysis
plugins
printer_parameters
printer_profiles
scripts
serial
server
slicing
system
temperature
terminalfilters
webcam
webcam
server
server
api
api
access
connection
files
job
languages
printer
printer_profiles
settings
slicing
system
timelapse
users
util
util
csrf
flask
sockjs
tornado
watchdog
webassets
views
settings
slicing
slicing
exceptions
systemcommands
timelapse
users
util
util
comm
commandline
connectivity
dev
files
fixes
gcodeInterpreter
jinja
json
json
encoding
serializing
net
paths
pip
piptestballoon
piptestballoon
setup
platform
text
tz
version
yaml
vendor
vendor
awesome_slugify
awesome_slugify
alt_translates
main
flask_principal
imp
sockjs
sockjs
tornado
tornado
basehandler
conn
migrate
periodic
proto
router
session
sessioncontainer
static
stats
transports
transports
base
eventsource
htmlfile
jsonp
pollingbase
rawwebsocket
streamingbase
websocket
xhr
xhrstreaming
util
websocket
with_attrs_docs
webcams
octoprint_setuptools
Table of contents
octoprint.server.api
octoprint.server.api
#
Back to top