OctoPrint.printerprofiles

OctoPrint.printerprofiles.list(opts)

Retrieves a list of all configured printer profiles.

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

A jQuery Promise for the request’s response

OctoPrint.printerprofiles.get(id, opts)
Arguments:
  • id (string) – The identifier of the profile to retrieve
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrint.printerprofiles.add(profile, additional, opts)

Adds a new profile to OctoPrint.

Arguments:
  • profile (string) – The data of the profile to add
  • basedOn (string) – The identifier of the profile to base this profile on (optional)
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrint.printerprofiles.update(id, profile, opts)

Updates an existing profile in OctoPrint.

Arguments:
  • id (string) – The identifier of the profile to update
  • profile (string) – The data of the profile to update
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

OctoPrint.printerprofiles.delete(id, opts)

Deletes a profile in OctoPrint.

Arguments:
  • id (string) – The identifier of the profile to delete
  • opts (object) – Additional options for the request
Returns Promise:
 

A jQuery Promise for the request’s response

See also

Printer profile operations
The documentation of the underlying printer profile API.