api

Create a retention rule

This endpoint requires admin access

post/ocs/v2.php/apps/files_retention/api/v1/retentions

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

tagidinteger required

Tag the retention is based on

timeunit0 | 1 | 2 | 3 required

Time unit of the retention (days, weeks, months, years)

timeamountinteger required

Amount of time units that have to be passed

timeafter0 | 1

Whether retention time is based creation time (0) or modification time (1)

Response

Retention rule created

Changes

Changed in 3 of the 4 revisions of this API.91017

Dec 20, 2025db5a22e1e7d33See the full diff
- ○
  the request property became optional
  request-property-became-optional
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Mar 26, 2025e4e3f2a5e08a266See the full diff
- ▲
  request property was restricted to a list of enum values
  request-property-became-enum
- ▲
  request property was restricted to a list of enum values
  request-property-became-enum
- ●
  added the new 0.00 enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new 0.00 enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new 1.00 enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new 1.00 enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new 2.00 enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new 3.00 enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the new 0.00 enum value to the request property
  request-property-enum-value-added
- ○
  added the new 0.00 enum value to the request property
  request-property-enum-value-added
- ○
  added the new 1.00 enum value to the request property
  request-property-enum-value-added
- ○
  added the new 1.00 enum value to the request property
  request-property-enum-value-added
- ○
  added the new 2.00 enum value to the request property
  request-property-enum-value-added
- ○
  added the new 3.00 enum value to the request property
  request-property-enum-value-added
Mar 26, 2025ae08f25fe8aa748See the full diff
- ▲
  the request property became required
  request-property-became-required
- ▲
  removed the enum value 0.00 of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value 0.00 of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value 1.00 of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value 1.00 of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value 2.00 of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value 3.00 of the request property
  request-property-enum-value-removed
- ●
  the request property's max was set to 1.00
  request-property-max-set
- ●
  the request property's max was set to 3.00
  request-property-max-set
- ●
  the request property's min was set to 0.00
  request-property-min-set
- ●
  the request property's min was set to 0.00
  request-property-min-set
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the 0.00 enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the 0.00 enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the 1.00 enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the 1.00 enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the 2.00 enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the 3.00 enum value from the // response property for the response status
  response-property-enum-value-removed

Full history