History

Nicola Murino 5618b95372 improve some docs Signed-off-by: Nicola Murino <nicola.murino@gmail.com>		2022-10-30 08:34:16 +01:00
..
README.md	improve some docs	2022-10-30 08:34:16 +01:00
scanuserquota	add basic REST APIs for data retention	2021-09-25 12:20:31 +02:00

README.md

Update user quota

⚠️ Since v2.4.0 you can use the EventManager to schedule quota scans.

The scanuserquota example script shows how to use the SFTPGo REST API to update the users' quota.

The stored quota may be incorrect for several reasons, such as an unexpected shutdown while uploading files, temporary provider failures, files copied outside of SFTPGo, and so on.

A quota scan updates the number of files and their total size for the specified user and the virtual folders, if any, included in his quota.

If you want to track quotas, a scheduled quota scan is recommended. You can use this example as a starting point.

The script is written in Python and has the following requirements:

python3 or python2
python Requests module

The provided example tries to connect to an SFTPGo instance running on 127.0.0.1:8080 using the following credentials:

username: admin
password: password

Please edit the script according to your needs.