data retention

Start a retention check

Starts a new retention check for the given user. If a retention check for this user is already active a 409 status code is returned

post/retention/users/{username}/check

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/retention/users/:username/check/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

pathstring

virtual directory path as seen by users, if no other specific retention is defined, the retention applies for sub directories too. For example if retention is defined for the paths "/" and "/sub" then the retention for "/" is applied for any file outside the "/sub" directory

retentioninteger

retention time in hours. All the files with a modification time older than the defined value will be deleted. 0 means exclude this path

delete_empty_dirsboolean

if enabled, empty directories will be deleted

ignore_user_permissionsboolean

if enabled, files will be deleted even if the user does not have the delete permission. The default is "false" which means that files will be skipped if the user does not have permission to delete them. File patterns filters will always be silently ignored

Example request

[
  {
    "path": "/",
    "retention": 24
  }
]

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any

Changes

No recorded changes to this operation across all 1 revision of this API.