OctoPrintClient.printerprofiles

OctoPrintClient.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

OctoPrintClient.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

OctoPrintClient.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

OctoPrintClient.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

OctoPrintClient.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.