How do I schedule an API to run at a specific time?

Modified on Mon, 21 May 2018 at 10:57 AM


To schedule an API to run at a specific time, first navigate to the 'Scheduler' on the side bar. On this page, you can create, edit, and review any scheduled API jobs for the APIs in your Illuminate setup. To create a job, simply click on the 'Add Job' button to proceed.


Once you are in the job creation interface, you will first need to specify a name for your job as well as which API you wish for the job to run. Once you have done so, a new field will appear allowing you to select which data consumer the job will run for. It is important to note that only those consumers you have authorized the API for will be available for scheduling.


Once you have chosen the API and consumer, set a start and end date for your job, as well as the frequency and start time in the following fields. You will then be given the option to specify the value of any input parameters the job will use to run the API if the API requires any. Once you have done so, simply click 'Save' to save the job and set it to run at he specified times.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article