Support

Documentation

getFSFilters

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

Returns the filesystem 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 filesystem root, default [SITEROOT] (the main site database definition). See getFSRoots

Response Data returned

An array of JSON objects is returned. Each object has the following keys:

node

The relative path to the file or directory database on which the filter is applied.

type

The filter type:

  • directories. Exclude this directory.

  • skipdirs. Exclude the subdirectories contained in this directory.

  • skipfiles. Exclude the files contained in this directory.

  • files. Exclude this file.