Purge completed background jobs
Deletes terminal background jobs older than a retention cutoff.
olderThan?string
ISO-8601 timestamp cutoff; only terminal jobs older than this instant are eligible.
Format
date-timestatuses?array<PurgeableBackgroundJobStatus>
Optional terminal background job statuses to target for purging. If omitted, all terminal statuses are eligible. Canonical values are BACKGROUND_JOB_SUCCEEDED, BACKGROUND_JOB_FAILED, and BACKGROUND_JOB_CANCELED. Short aliases SUCCEEDED, FAILED, and CANCELED are also accepted for compatibility.
dryRun?boolean
If true, report purge counts without deleting any rows.
limit?integer
Maximum number of jobs to purge in this request. Must be >= 0; 0 means no limit.
Format
int32Range
0 <= valueResponse Body
curl -X POST "https://loading/v1/admin/background-jobs:purge" \ -H "Content-Type: application/json" \ -d '{}'{
"jobsPurged": 0,
"attemptsPurged": 0,
"referencesPurged": 0,
"dryRun": true
}Empty
Empty
Empty