OctoPrintClient.wizard

Note

All methods here require that the used API token or a the existing browser session has admin rights.

OctoPrintClient.wizard.get(opts)

Retrieve additional data about registered wizards.

Arguments:
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrintClient.wizard.finish(handled, opts)

Inform wizards that the wizard dialog has been finished.

Arguments:
  • handled (list) – List of identifiers of handled wizards
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

See also

Wizard API
The documentation of the underlying wizard API.