Skip to main content

Scheduling API Tests

The Schedule tool, accessible from within each test, allows you to schedule API tests to run as often as you’d like, with granular control as to when it runs. Let’s take a look at how it works.

What You'll Need#

Publish the Working Copy#

Our API Testing interface has a unique Working Copy / Published Copy system that allows you to edit a test without affecting the live, currently active version.

  1. Once you've finish editing your test, navigate to the Unpublished changes section, where it states that your test is currently unpublished.
    Unpublished Test
  2. Hover your mouse over the section to reveal the Clear and Publish buttons.
    Publish Test Button
  3. Click the Publish button to publish your working copy.
    Published Test

Create a New Schedule#

  1. Click the Schedule tab to access the Scheduler.
    Schedule Tab

  2. Click Create Schedule.
    Create Schedule

    The New Schedule window will appear.
    Example Schedule

  3. Enter a Schedule Name (Description is optional).

  4. Choose a Time Zone to specify when you'd like test will run. Double-check that you're using the right one (i.e., if you're in Berlin and want to run at your local time, make sure to select Europe/Berlin instead of America/Los Angeles)!

  5. Use the Minute, Hour, Day, and Month parameters to schedule the frequency at which you'd like your test to run. It will repeat at your configured time and interval.

  6. Optionally, you can add a Sauce Connect Proxy tunnel by selecting one from the No tunnel dropdown and/or enter a key=value variable override.

  7. When you're finished, click Save.

  8. You'll be taken back to the Schedule page. The test you've scheduled should populate in the nav.
    Schedule confirmation

  9. If you hover your mouse over it, you can see the options to Pause, Edit, or Delete the schedule.
    Scheduler options

Editing the Schedule#

If you need to edit the schedule or any other part of the test, here's a shortcut:

  1. Go to your the Tests tab of your Project.
  2. Hover your mouse over the test line item. You'll see icons that allow you to apply edits to your actual test and to the schedule.
    Schedules Icons
    From left to right:
    • Pencil icon: Edits the test (opens the Compose tab).
    • Play icon: Runs the test manually.
    • Calendar icon: Opens the scheduler directly without opening the test first.
    • Trash icon: Deletes the test.