Run whole projects at a set time

Monitors that run every saved request of a project, a team's projects or the organization's at a set time.

In short

A monitor checks one request or suite every few minutes or at a set time. At a set time - hourly, daily, weekly or monthly - it can also run every saved request of a whole project, of a team's projects or of the organization's. Every monitor runs as a person, with that person's access, and is listed in "Watch" › "Monitors".

Before you start

• Who: making or changing a monitor needs Edit on what it covers - for a team's or the organization's projects, on each of them you can open.
• Plan: a monitor of a whole project, a team or the organization needs the Automation feature of a paid plan, and its requests count toward your API requests. A monitor of one request or suite needs monitoring; Free allows basic monitors, whose checks have an allowance of their own.
• First: save the request and test it once by hand.

Steps

1. Save the request and test it once by hand.
2. Press "Save as monitor" on it, or open "Watch" - it opens on "Monitors" - and press "New monitor". See /help/api-testing/monitors-and-alerts.
3. Pick the environment, how often and a name, and press "Create monitor".

1. Open "Watch" › "Monitors" and press "New monitor".
2. Under "What it checks", choose "A whole project" (the open one), "A team's projects" or "The organization's" - the last two in the organization you work in.
3. Choose how often and the time on your own clock, and press "Create monitor".

Result: the next-run time shows when it is due. Each run is one check on the monitor's strip, which says how many requests failed in how many projects, and every request lands in its own history.

Good to know

• Hourly needs no time, daily needs a time, weekly adds a day and monthly picks a day up to the 28th.
• You cannot change what a monitor checks after creating it; make a new one.
• The switch in the "On" column turns a monitor off without deleting it. "Run now" runs it at once, as you and on your API requests, even while it is off, and says how it went.
• A monitor of a team's or the organization's projects runs, each time, only the projects its person can run at that moment, and names those it left out.
• A team's or the organization's monitor runs each request in its own environment. A whole project's monitor may name one environment.
• "Runs as" names whose access it uses; "Take over" makes it yours.
• Monitor runs and runs by hand use the same sending, history, comparison and access rules. A whole project's, a team's or the organization's monitor spends your API requests and is outside the monitor limit; a request or suite monitor uses the monitor checks.
• Pause a monitor while the environment is down or under maintenance, and resume it afterwards.
• "Watch" › "Monitors" shows the monitors of the open project first, with the status page card under them: the monitors of the open project with the team's and organization's ones that cover it; "All projects" shows every monitor. With nothing yet it offers "New monitor" and "Use a template" (the "Uptime monitor" template: /help/api-testing/start-from-a-template).
• "Delete monitor", in the row's menu, stops it at once and its checks go with it; "Undo" on the message brings it back.

What each run left

Open a monitor from its row: its strip keeps each check - when it ran, how many requests failed in how many projects, how long it took and what it left out. "Run history", in the row's menu or at the top of the monitor, lists every run newest first, including the ones someone pressed "Run now" for. A failed run offers "Review failures", which opens what failed. Individual results also appear in each request's own history.

If something goes wrong

• A monitor says it stopped: the person it runs as can no longer run what it covers. Press "Take over".
• A run says projects were skipped: its person can no longer run them.
• It did not run at the hour you expected: the time is on the clock of the zone it shows.
• "A weekly time needs a day of the week." and "A monthly time needs a day of the month between 1 and 28.": choose the day.
• "Time of day must be between 00:00 and 23:59." and "Choose a time zone this server knows, such as Europe/Berlin.": fix the time.
• "A monitor of a whole project, team or organization runs at a planned time": choose how often instead of an interval.
• "This plan does not include planned runs of whole projects, teams or organizations.": your plan has no Automation feature.
• "This team or organization has no projects you can open yet.": file a project under the team first.

Related

• /help/api-testing/monitors-and-alerts
• /help/api-testing/permissions-sharing