ATatlassian
Audit

Get retention period

Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted.

Permissions required: 'Confluence Administrator' global permission.

get/wiki/rest/api/audit/retention

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/audit/retention
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:audit-log:confluence

Response

Returned if the requested retention period is returned.

numberinteger required

The number of units for the retention period.

units'NANOS' | 'MICROS' | 'MILLIS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'HALF_DAYS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS' | 'DECADES' | 'CENTURIES' | 'MILLENNIA' | 'ERAS' | 'FOREVER' required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.