OctoPrintClient.system
¶
Note
All methods here require that the used API token or the existing browser session has admin rights.
-
OctoPrintClient.system.
getCommands
(opts)¶ Retrieves a list of configured system commands for both
core
andcustom
sources.Arguments: - opts (object) – Additional options for the request
Returns Promise: A jQuery Promise for the request’s response
-
OctoPrintClient.system.
getCommandsForSource
(source, opts)¶ Retrieves a list of system commands, limiting it to the specified
source
, which might be eithercore
orcustom
.Arguments: - opts (object) – Additional options for the request
Returns Promise: A jQuery Promise for the request’s response
-
OctoPrintClient.system.
executeCommand
(source, action, opts)¶ Executes command
action
onsource
.Arguments: - source (string) – The source of the command to execute
- action (string) – The action identifier of the command to execute
- opts (object) – Additional options for the request
Returns Promise: A jQuery Promise for the request’s response
See also
- System API
- Documentation of the underlying system API.