![[Warning]](/media/com_docimport/admonition/warning.png) | 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. |
Returns the filesystem entities (files and folders) exclusion filters for the chosen backup profile. Available since API version 340.
Request Data expected
All fields are MANDATORY.
- profile
-
Integer. The profile ID you want to list.
- root
-
string. The UUID of the database root, default [SITEDB] (the main site database definition). See getDBRoots
- subdirectory
-
string. The relative path to the subdirectory you are listing. The path is relative to the root specified above. The subdirectory components MUST be separated with forward slashes and MUST NOT begin or end with a forward slash.
Response Data returned
A JSON object is returned with the keys
- root
-
The UUID of the database root.
- crumbs
-
An array of folder names leading from the root to the current subdirectory
- folders
-
A JSON object. The property keys are folder names. The property values are JSON objects with the following format:
- directories
-
Is this entire directory and all of its contents to be excluded? 0 = No. 1 = Yes. 2 = Always (excluded by an algorithmic, platform-specific or regular expression filter)
- skipfiles
-
Are the files contained in this directory to be excluded? 0 = No. 1 = Yes. 2 = Always (excluded by an algorithmic, platform-specific or regular expression filter)
- skipdirs
-
Are the directories contained in this directory to be excluded? 0 = No. 1 = Yes. 2 = Always (excluded by an algorithmic, platform-specific or regular expression filter)
- files
-
A JSON object. The property keys are file names. The property values are JSON objects with the following format:
- files
-
Is this file to be excluded? 0 = No. 1 = Yes. 2 = Always (excluded by an algorithmic, platform-specific or regular expression filter)
- size
-
The size of the file in bytes.