Homepage

admin_background_jobs_delete_all

Last edit: Nov 10, 2026

Deletes background jobs of this instance that match the filter and have not
run yet or have failed, and returns the deleted jobs. Looks at scheduled jobs
unless filter.type says otherwise. Deletes at most 100 jobs per call (the
first page of matches), so repeat the call until no results are returned

admin_background_jobs_delete_all(
  filter: BackgroundJobsFilterInput
): BackgroundJobsResult

Arguments

filter (BackgroundJobsFilterInput)

Conditions the deleted jobs must match; when omitted, all scheduled jobs are deleted (up to 100)

Type

BackgroundJobsResult

Result of deleting background jobs

Questions?

We are always happy to help with any questions you may have.

contact us