Support

Documentation

setIncludedDirectory

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

Add an additional included directory definition. Available since API version 340.

Request Data expected

profile

Integer. The profile ID you want to list.

uuid

String. A unique identified for this definition. If left empty a UUIDv4 will be generated automatically.

path

String. The absolute filesystem path of the included directory.

virtualFolder

String. The name of the folder inside the archive's extradirs directory where the files of the included directory will be stored. Default: the name of the included directory (last component of its path).

Response Data returned

A JSON object

success

Bool. True on success.

newstate

Bool. Ignored (always false).