Skip to content
Authrim

Describe audit storage cleanup

POST
/api/admin/settings/audit-storage/cleanup
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/settings/audit-storage/cleanup \
  --header 'Authorization: Bearer <token>'

Returns cleanup capabilities and operational notes. Scheduled tasks and queue consumers perform actual retention cleanup.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
boolean
profile_id
string
source
string
note
string
hot_query

Hot query capability status.

object
key
additional properties
operational_policy

Resolved audit operational policy.

object
key
additional properties
queue

Audit queue status.

object
key
additional properties
scheduled_cleanup

Scheduled cleanup windows.

object
key
additional properties
functions

Cleanup function names when supported.

object
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "profile_id": "managed-audit-profile",
  "source": "runtime_profile",
  "note": "Retention cleanup is typically handled by scheduled tasks. For manual cleanup, use the Queue Consumer functions directly.",
  "hot_query": {
    "status": "supported",
    "reason": null
  },
  "operational_policy": {
    "cleanup": {
      "scheduledEventCleanup": true
    }
  },
  "queue": {
    "audit_queue": {
      "configured": true
    }
  },
  "scheduled_cleanup": {
    "event_log": "Daily at 02:00 UTC",
    "pii_log": "Daily at 03:00 UTC"
  },
  "functions": {
    "event_log": "cleanupExpiredTenantEventLogs(db, tenantId, batchSize)",
    "pii_log": "cleanupExpiredTenantPIILogs(db, tenantId, batchSize)"
  }
}

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