PUT /wiki/rest/api/audit/retention

Sets the retention period for records in the audit log. The retention period can be set to a maximum of 1 year.

Permissions required: 'Confluence Administrator' global permission.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
units String Yes

The unit of time that the retention period is measured in.

Possible values:

  • "MICROS"
  • "MINUTES"
  • "NANOS"
  • "HOURS"
  • "MONTHS"
  • "DAYS"
  • "FOREVER"
  • "DECADES"
  • "HALF_DAYS"
  • "YEARS"
  • "CENTURIES"
  • "WEEKS"
  • "MILLIS"
  • "ERAS"
  • "MILLENNIA"
  • "SECONDS"
number Integer Yes

The number of units for the retention period.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.