Schedule API Health Checks
The Schedules feature allows you to define automated health check routines for your monitored Ethos API endpoints. These schedules determine when, how often, and which endpoints are checked, helping your institution ensure consistent visibility into API performance and availability.
Automate health checks for selected Ethos API endpoints
Align monitoring with institutional needs (e.g., during business hours, overnight, or high-traffic periods)
Enable targeted monitoring for critical or sensitive integrations (e.g., Admissions, Financial Aid)
Create a New Schedule
The Schedule Settings page allows you to define when and how often your Ethos API endpoints are checked, and who should be notified of results or failures. Follow the steps below to configure a schedule.
Navigate to the Schedules tab in the Ethos API Monitor.
Click Settings.
From the API List select the APIs you would like to include in the check.
Click on Schedule to configure the timing for this health check.
Select your local time zone from the Time Zone dropdown.
Choose Daily or Weekly as the check interval.
Select the start time in the Start Point field.
Toggle Send All Results Summary if you want notifications after every run.
Toggle Send on Error to receive alerts only when a check fails.
Select recipients in the Who to Notify dropdown.
Enter a descriptive name for the schedule in the Name Schedule field.
Toggle the Enable Schedule switch if you want the schedule to be active right away.
Disable the schedule at any time by turning the switch off.
Click Save Settings to finish.
Note: Once a schedule configuration is saved, it will appear on the main Schedule page and the Runs page each time it executes, with pass/fail status and execution details.
Last updated