Update a data retention category.

PUT

/api/admin/data-retention/categories/{category}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/data-retention/categories/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "retention_days": 90 }'

Updates the retention period for one supported data retention category in the tenant settings JSON and records an audit log entry. retention_days must be between 1 and 3650.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

category

required

string

Retention category key such as audit_logs, session_data, tombstones, auth_codes, refresh_tokens, or access_tokens.

Request Body ^required

Media type application/json

object

retention_days

required

integer

>= 1 <= 3650

key

additional properties

Example

{
  "retention_days": 90
}

Responses

200

Data retention category update response.

Media type application/json

object

category

required

string

retention_days

required

integer

updated_at

required

string format: date-time

key

additional properties

Example ^generated

{
  "category": "example",
  "retention_days": 1,
  "updated_at": "2026-04-15T12:00:00Z"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}