Scheduling
Schedules define when job groups run automatically in Alteryx One. You can list, inspect, enable, and disable them from the CLI. Mutating commands are dry-run by default — add --apply to commit.
Enterprise tier required. Scheduling endpoints return 404 on some workspace tiers. Commands are present in all builds but will only succeed on enterprise-tier accounts.
Quick reference
Section titled “Quick reference”| Command | What it does |
|---|---|
ayx one scheduling list |
List all schedules |
ayx one scheduling count |
Count schedules |
ayx one scheduling detail |
Inspect a single schedule |
ayx one scheduling enable |
Enable a schedule |
ayx one scheduling disable |
Disable a schedule |
To view the schedules attached to a specific plan, use ayx one plans schedules <id>.
Listing schedules
Section titled “Listing schedules”# All schedules (paginated — first page)ayx one scheduling list
# All schedules, all pagesayx one scheduling list --all
# Scoped to a profileayx one scheduling list --profile <profile-id>
# Limit results per pageayx one scheduling list --limit 50
# Machine-readableayx --output json one scheduling list --allCounting schedules
Section titled “Counting schedules”ayx one scheduling count
ayx --output json one scheduling countUseful for a quick health check — verify the number of active schedules hasn’t changed unexpectedly.
Inspecting a schedule
Section titled “Inspecting a schedule”ayx one scheduling detail <id>
ayx --output json one scheduling detail <id>detail returns the full schedule record including the cron expression, target job group, enabled state, and last/next run times.
Enabling a schedule
Section titled “Enabling a schedule”# Dry-run — shows the request, changes nothingayx one scheduling enable <id>
# Commitayx one scheduling enable <id> --applyDisabling a schedule
Section titled “Disabling a schedule”# Dry-runayx one scheduling disable <id>
# Commitayx one scheduling disable <id> --apply
# Non-interactive (CI / scripts)ayx one scheduling disable <id> --apply --yesDisabling a schedule stops future runs but does not cancel any run that is already in progress.
Automation patterns
Section titled “Automation patterns”Audit all enabled schedules:
ayx --output json one scheduling list --all \ | jq -r '.data[] | select(.enabled == true) | [.id, .name, .nextRunAt] | @tsv'Disable every schedule in a profile before a maintenance window:
ayx --output json one scheduling list --all --profile <profile-id> \ | jq -r '.data[] | select(.enabled == true) | .id' \ | xargs -I{} ayx one scheduling disable {} --apply --yesRe-enable them after maintenance:
ayx --output json one scheduling list --all --profile <profile-id> \ | jq -r '.data[] | select(.enabled == false) | .id' \ | xargs -I{} ayx one scheduling enable {} --applyCount active vs inactive schedules for a status report:
ayx --output json one scheduling list --all | jq ' .data | { total: length, enabled: (map(select(.enabled == true)) | length), disabled: (map(select(.enabled == false)) | length) }'Related
Section titled “Related”- Job groups — run and inspect the job groups schedules trigger
- Plan schedules — view schedules attached to a specific plan via
ayx one plans schedules - Safety model — how dry-run and
--applywork - Output & automation — JSON envelope and scripting patterns