SFTPGo Octri Preview
GET/retention/users/checks

Get active retention checks

Returns a list of retention checks that are currently in progress

5 status codes
200successful operation
folderstringoptional
Source folder name for folder-scoped retention checks. Empty for user-bound retention
foldersarray<object>optional
start_timeintegeroptional
check start time as unix timestamp in milliseconds
usernamestringoptional
Username to which the retention check refers. For folder-scoped checks this is the canonical system identity; the source folder is reported in `folder`
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.