Schedules (CLI)

Manage Autopilot test schedules from the obs CLI, including the chainable bulk stop/resume action for piping schedule IDs from a list or another command.

Manage Autopilot test schedules: cron schedules that run a specific Autopilot test.

obs schedule create --test-id <testId> --interval "*/30 * * * *"
obs schedule list --test-id <testId>
obs schedule get <id>
obs schedule update <id> --interval "0 * * * *" --enable-alerts
obs schedule stop <id>          # resume with `obs schedule resume <id>`
obs schedule stop-all           # resume-all to reactivate every schedule
obs schedule delete <id> -y

Alias: obs sched.

Create flags: --test-id <id> (required), -i, --interval <cron> (required), --retry-count <n>, --retry-interval <seconds>, --no-alerts. Update flags: -i, --interval, --retry-count, --retry-interval, --enable-alerts / --disable-alerts (use stop/resume to pause or activate the schedule itself).

Chainable bulk stop/resume#

bulk <stop|resume> applies an action to many schedules at once, reading IDs from a repeatable --id and/or piped stdin:

obs schedule bulk stop --id <id1> --id <id2>
obs schedule list --json | jq -r '.data[].id' | obs schedule bulk stop --stdin
obs schedule list --test-id <testId> --json | jq -r '.data[].id' | obs schedule bulk resume --stdin

--stdin accepts whitespace- or JSON-array-separated IDs. Bulk prints a per-ID success/failure summary and exits non-zero if any ID failed, so a pipeline can detect a partial failure instead of assuming success.

Notes#

create needs an existing Autopilot test (--test-id); this command does not create tests, only their schedules.

See also: Autopilot Suites for generating and managing the tests a schedule runs, and the CLI reference overview.

Was this page helpful?