Docmost Octri Preview
POST/audit/retention/update

Set the audit log retention period

Minimum 30 days. Cloud workspaces are additionally capped at 365 days.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
auditRetentionDaysintegerrequired
Days to keep audit entries. Cloud workspaces are capped at 365.

3 status codes
200Retention updated
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Retention below 30 days, or above the 365-day cloud cap
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Forbidden, or audit logs not included in the current licence
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned: Retention below 30 days, or above the 365-day cloud cap. A 403 is returned: Forbidden, or audit logs not included in the current licence.