SCscaleapi
task-retention

Clean Task

Changed on

Delete content-bearing rows for a stale task.

Refuses on active tasks, in-flight workflows, or unprocessed events regardless of force. The force=true flag only bypasses the idle-threshold check.

post/tasks/{task_id}/clean

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

task_idstring required

Request body

forceboolean

Skip the idle-threshold check. Active-workflow and unprocessed-events checks still apply. Admin use only.

idle_daysinteger

Idle threshold in days (ignored when force=true).

Response

Successful Response

task_idstring required
cleaned_atstring date-time required
messages_deletedinteger required
task_states_deletedinteger required
events_deletedinteger required

Changes