GoodMemGoodMem
ReferenceAPIREST APIGeneral

Purge completed background jobs

Deletes terminal background jobs older than a retention cutoff.

POST
/v1/admin/background-jobs:purge
olderThan?string

ISO-8601 timestamp cutoff; only terminal jobs older than this instant are eligible.

Formatdate-time
statuses?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.

Formatint32
Range0 <= value

Response 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