NEnextcloud
api

Create a retention rule

Changed on

This endpoint requires admin access

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

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or HTTP basic

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

  • db5a22e1e7d3Revision changes
    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e4e3f2a5e08aRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • warning

      added the new 0.00 enum value to the // response property for the response status

    • warning

      added the new 0.00 enum value to the // response property for the response status

    • warning

      added the new 1.00 enum value to the // response property for the response status

    • warning

      added the new 1.00 enum value to the // response property for the response status

    • warning

      added the new 2.00 enum value to the // response property for the response status

    • warning

      added the new 3.00 enum value to the // response property for the response status

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the new 3.00 enum value to the request property