POST/audit/retention

Get the audit log retention period

Retrieves the audit log retention period for the workspace. Use this operation to check how long workspace audit logs are retained. Access may depend on workspace permissions and the current licence.

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

2 status codes
200Returns the audit log retention period in days.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when access is forbidden or audit logs are not included in the current licence.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when access is forbidden or audit logs are not included in the current licence. Workspace admin rights are required to access audit retention settings; the authenticated user must have the admin role.