OctoPrint.logs

Note

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

OctoPrint.logs.list(opts)

Retrieves a list of log files.

See Retrieve a list of available log files for details.

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

A jQuery Promise for the request’s response

OctoPrint.logs.delete(path, opts)

Deletes the specified log path.

See Delete a specific log file for details.

Arguments:
  • path (string) – The path to the log file to delete
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrint.logs.download(path, opts)

Downloads the specified log file.

See OctoPrint.download() for more details on the underlying library download mechanism.

Arguments:
  • path (string) – The path to the log file to download
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response