Update the trash bin auto-clearing setting

PUT /api/2.0/files/settings/autocleanup

Request

Updates the trash bin auto-clearing setting.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Auto-clearing request parameters

setboolean

Enables the auto-clearing or not

gapone of
.enum of string

[OneWeek - One week, TwoWeeks - Two weeks, OneMonth - One month, ThirtyDays - Thirty days, TwoMonths - Two months, ThreeMonths - Three months]

Can be one of: OneWeek, TwoWeeks, OneMonth, ThirtyDays, TwoMonths, ThreeMonths.

.enum of integer

[1 - One week, 2 - Two weeks, 3 - One month, 4 - Thirty days, 5 - Two months, 6 - Three months]

Can be one of: 1, 2, 3, 4, 5, 6.

Examples

PUT /api/2.0/files/settings/autocleanup HTTP/1.1
Accept: application/json
Content-Length: 17
Content-Type: application/json
Host: example.com

{
  "set": true
}
curl --request PUT \
  --url https://example.com/api/2.0/files/settings/autocleanup \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "set": true
}'

Responses

200

The auto-clearing setting properties: auto-clearing or not, a time interval when the auto-clearing will be performed

isAutoCleanUpboolean

Specifies if the auto-clearing setting is enabled or not

gapone of
.enum of string

[OneWeek - One week, TwoWeeks - Two weeks, OneMonth - One month, ThirtyDays - Thirty days, TwoMonths - Two months, ThreeMonths - Three months]

Can be one of: OneWeek, TwoWeeks, OneMonth, ThirtyDays, TwoMonths, ThreeMonths.

.enum of integer

[1 - One week, 2 - Two weeks, 3 - One month, 4 - Thirty days, 5 - Two months, 6 - Three months]

Can be one of: 1, 2, 3, 4, 5, 6.

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).