Pause CronAdmin Scope

Note: Ensure you have installed the required package to use this SDK method.

You can pass the cron ID or name of the Pre-defined or Dynamic cron to the pauseCron() SDK method to temporarily halt a cron from submitting a job to the job pool.

The jobScheduling reference used in the code snippets below is the component instance created to perform these operations.

copy
const pausedCronWithName = await jobScheduling.CRON.pauseCron('test_cron'); // pause cron with cron name
const pausedCronWithId = await jobScheduling.CRON.pauseCron('1234567890'); // pause cron with cron ID

Last Updated 2026-07-02 14:51:41 +0530 IST