Plans

Plans in Alteryx One group flows into a single orchestrated unit that can be run on demand or on a schedule. The ayx one plans branch covers the full lifecycle: browsing, creating, running, updating, sharing, and managing access.

Mutating commands are dry-run by default — add --apply to commit. Applied mutations prompt for confirmation; add --yes for non-interactive scripts.

Enterprise tier required. Plans endpoints return 404 on some workspace tiers. Commands are present in all builds but will only succeed on enterprise-tier accounts.

Quick reference

Command	What it does
`ayx one plans list`	List plans in the workspace
`ayx one plans count`	Return total plan count
`ayx one plans detail`	Fetch a plan’s summary metadata
`ayx one plans full`	Fetch a plan’s full metadata including flows
`ayx one plans run`	Trigger an on-demand plan run
`ayx one plans run-parameters`	List the run parameters a plan accepts
`ayx one plans create`	Create a new plan
`ayx one plans update`	Update a plan
`ayx one plans delete`	Delete a plan
`ayx one plans share`	Share a plan with users or groups
`ayx one plans permissions`	Read permissions for a plan
`ayx one plans schedules`	List schedules attached to a plan
`ayx one plans export`	Export a plan to a portable format
`ayx one plans import`	Import a plan

List and inspect

List plans

ayx one plans list
ayx one plans list --profile <name>
ayx one plans list --limit 50
ayx one plans list --all
ayx one plans list --all --max-pages 10

--all follows pagination automatically. Pass --page-token to resume from a specific page.

Count plans

ayx one plans count
ayx one plans count --profile <name>

Plan detail

# Summary record
ayx one plans detail <plan-id>

# Full record including flows
ayx one plans full <plan-id>

Use detail for fast lookups. Use full when you need to inspect which flows are in the plan or their configuration.

Run parameters

ayx one plans run-parameters <plan-id>

Lists the parameters that can be passed when triggering a run.

Schedules

ayx one plans schedules <plan-id>

Returns the schedules configured for this plan. See Plan schedules for detail.

Permissions

ayx one plans permissions <plan-id>
ayx one plans permissions <plan-id> --subject-id <subject-id>

--subject-id filters the response to a specific user or group. Omit it to return all permission entries for the plan. When --subject-id is provided, the command revokes that permission and is treated as a mutation.

Run

# Dry-run
ayx one plans run <plan-id>

# Trigger an on-demand run
ayx one plans run <plan-id> --apply

# Non-interactive
ayx one plans run <plan-id> --apply --yes

Create and update

# Preview
ayx one plans create --body plan.json

# Create
ayx one plans create --body plan.json --apply

# Update
ayx one plans update <plan-id> --body patch.json --apply

# Non-interactive create/update
ayx one plans create --body plan.json --apply --yes
ayx one plans update <plan-id> --body patch.json --apply --yes

Both commands accept --body <FILE|JSON|->: a JSON file, inline non-secret JSON, or - for piped stdin. Inline values are visible in shell history and process listings, so prefer a file or stdin for sensitive payloads.

# Preview
ayx one plans share <plan-id> --body permissions.json

# Commit
ayx one plans share <plan-id> --body permissions.json --apply

# Non-interactive
ayx one plans share <plan-id> --body permissions.json --apply --yes

Delete

# Dry-run
ayx one plans delete <plan-id>

# Commit
ayx one plans delete <plan-id> --apply

# Non-interactive
ayx one plans delete <plan-id> --apply --yes

Automation patterns

List all plans as JSON

ayx -o json one plans list --all \
  | jq '.data.items[]'

Find a plan by name

ayx -o json one plans list --all \
  | jq -r '.data.items[] | select(.name == "Daily ETL") | .id'

Run a plan and check success

result=$(ayx -o json one plans run <plan-id> --apply)
echo "$result" | jq -e '.ok'

Run plans in a specific environment

ayx -o json --environment prod one plans list --all