Support

Documentation

saveProfile

[Warning]Warning

DEPRECATED - This method will be removed in Akeeba Backup for Joomla 10, Akeeba Backup for WordPress 8, and Akeeba Solo 8. Versions of our software released after September 2023 may no longer include this method even if their major version is below those specified in this message.

Updates or creates a backup profile. Available since API version 340.

Request Data expected

profile

Integer. The profile ID you are saving to. Do not define it (or set to 0) to save into a new backup profile.

source

Integer. The profile ID to copy all data from. Do not define it to read the data from the same profile as the one you're saving to.

description

String. The profile title.

quickicon

Integer. 1 to show a backup quickicon in the interface for this profile, 0 to hide it.

When both profile and source are empty or zero a new, empty profile is created. In this case the description MUST be present.

When profile is empty but source is not you are copying the source profile into a new profile (the engine and filter configuration is copied over).

When profile is non empty but source is empty you are editing an existing profile. In this case you should specify description or quickicon for the operation to make any sense.

When both the profile and source are non empty you are overwriting profile with the contents of the source profile.

Response Data returned

Boolean true.