Skip to content
Authrim

Run data retention cleanup.

POST
/api/admin/data-retention/cleanup
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/data-retention/cleanup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "categories": [ "audit_logs", "session_data" ], "idempotency_key": "cleanup-2026-06-19" }'

Synchronously deletes expired rows only when every selected category is tenant-local. A request selecting lookup_directory (including an omitted category list) fails closed with 503 and performs no deletion until the durable Control purge executor is enabled. Successful local-only responses contain per-category deletion counts and may be partial_success.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
categories
Array<string>
idempotency_key
string
key
additional properties
Example 
{
  "categories": [
    "audit_logs",
    "session_data"
  ],
  "idempotency_key": "cleanup-2026-06-19"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Data retention cleanup run response.

Media type application/json
object
id
required
string
tenant_id
required
string
status
required
string
Allowed values: completed partial_success
categories
required
Array<string>
records_deleted
required
object
key
additional properties
integer
started_at
required
string format: date-time
completed_at
required
string format: date-time
error_message
required
string | null
created_at
required
string format: date-time
key
additional properties
Example 
{
  "status": "completed"
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}

503

Section titled “503 ”

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"
}