Support

Documentation

setFSFilter

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

Sets or resets a filesystem exclusion filter. 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 fileystem root, default [SITEROOT] (the main site database definition). See getFSRoots

path

string. The path to the folder / file you are excluding. See getFSEntities.

type

string. The filter type. See getFSFilters.

status

int. 1 to set the filter, 0 to reset it.

Response Data returned

A JSON object with the following keys:

success

Bool. True if the operation succeeded.

newstate

Bool. The new state of the filter, true if the filter is enabled.