Managing a schedule

The Schedules page lists your organization's schedules, newest first. Each row shows:

• a status of enabled or paused, and the schedule's name;
• its cron expression, timezone and framework, and its first target, with +N when the template has more;
• next and last run times, in the schedule's zone — next shows — while the schedule is paused, and last shows — until the first successful fire;
• last occurrence skipped: … when the most recent occurrence was skipped (Caps and skips).

The heading shows how many schedules are enabled, as N active. Each row has two buttons, Disable (or Enable) and Delete. The console has no edit form for a schedule.

Creating a schedule¶

New schedule opens a six-step wizard: Targets, Scope, Rules, Framework, Cadence and Review. The first four are the steps of the new-engagement wizard and build the same payload. Cadence adds the Campaign name, the cadence and the timezone — see Cadence and Timezones and DST. Create schedule on the Review step saves the schedule enabled, with its first run time computed from that moment.

Creating a schedule creates no engagement, and ownership of the targets is not checked when it is saved. Both happen each time the schedule fires.

Disabling and enabling¶

Disable pauses the schedule. The ticker ignores paused schedules, and the stored next run time stays where it was. Enable turns the schedule back on without recomputing that time.

Editing¶

Apart from Enable and Disable, the console cannot change a schedule. The partner API can change four things on an existing schedule, with PATCH /api/v1/schedules/{id}: the name, the cadence (as an expression or a preset), the timezone, and whether it is enabled. A field that is left out, or sent as null, is not changed. Schedules in the API section describes the request.

• Expression or timezone. When either changes to a different value, the two are validated together, including the one-hour floor, and the next run time is recomputed from the moment of the edit. If the pair fails, the edit is rejected and nothing is saved.
• Name or enabled flag. The next run time is left alone, as it is for Enable in the console.

The engagement template — targets, scope, rules of engagement and framework — cannot be changed after the schedule is created, from the console or the API. To change it, delete the schedule and create a new one. See also Choosing a framework.

Deleting¶

Delete asks for confirmation: Delete "<name>"? Future occurrences will not run. Existing engagements are kept. Confirming removes the schedule permanently.

Deleting a schedule deletes nothing else. The engagements it created stay in your engagement list, with their findings, reports and lockers. Nothing on an engagement records which schedule created it, before or after the schedule is deleted.