Audit Log Retention

Retention settings control how long Audit Log events are stored before being permanently deleted. You can configure the retention period on a per-organization basis.

Get Retention

Get the configured event retention period for the given Organization.

cURL

 curl "https://api.workos.com/organizations/org_01EHZNVPK3SFK441A1RGBFSHRT/audit_logs_retention" \
  --header "Authorization: Bearer sk_example_123456789"

GET

`/organizations/:id/audit_logs_retention`

`Parameters`

`Returns`

Set Retention

Set the event retention period for the given Organization.

cURL

 curl --request PUT \
  --url "https://api.workos.com/organizations/org_01EHZNVPK3SFK441A1RGBFSHRT/audit_logs_retention" \
  --header "Authorization: Bearer sk_example_123456789" \
  --header "Content-Type: application/json" \
  -d @- <<'BODY'
    {
        "retention_period_in_days": 30
    }
BODY

PUT

`/organizations/:id/audit_logs_retention`

`Parameters`

`Returns`

ConfigurationContinue to the next section

Up next

Audit Log Retention

Get Retention

/organizations/:id/audit_logs_retention

Parameters

id: string

Returns

retention_period_in_days?: number

Set Retention

/organizations/:id/audit_logs_retention

retention_period_in_days: number

Parameters

id: string

Returns

retention_period_in_days?: number

`/organizations/:id/audit_logs_retention`

`Parameters`

`Returns`

`/organizations/:id/audit_logs_retention`

`Parameters`

`Returns`