Schedules
Automating playbook runs with cron-based schedules.
Overview
Schedules run playbooks automatically on a cron-defined interval. Each schedule references a playbook, inventory, and execution options.
Creating a schedule
Go to Schedules - New schedule and configure:
- NameDescriptive label for the schedule
- PlaybookWhich playbook to run
- InventoryTarget inventory
- Cron expressionWhen to run
- Run optionsExtra vars, vault credential, tags, and other execution options
- EnabledToggle to pause without deleting the schedule
Cron syntax
SculptOps uses standard 5-field cron syntax: minute hour day-of-month month day-of-week.
| Expression | Meaning |
|---|---|
| 0 * * * * | Every hour, on the hour |
| */15 * * * * | Every 15 minutes |
| 0 2 * * * | Every day at 02:00 |
| 0 3 * * 1 | Every Monday at 03:00 |
Timezone
Before saving production schedules, agree on a timezone convention with your team and verify the next-run preview shown by the UI.
Enabling and disabling schedules
Toggle the Enabled switch on any schedule to pause it without losing its configuration.
Note
Avoid overlapping automation by choosing intervals longer than the expected runtime of the playbook.
API
Schedules can be managed through the REST API by authenticated users with write access.
bash
GET /api/schedules
POST /api/schedules
PATCH /api/schedules/:id
DELETE /api/schedules/:id