Skip to content
ayx-rsv0.15.0

Alteryx One overview

ayx one is the primary command surface for Alteryx One. It gives you programmatic access to every major area of the platform: running and managing flows, orchestrating plans, managing data connections, inspecting job groups, administering users and workspaces, and more.

All mutating commands are dry-run by default. Nothing changes on the server until you add --apply. Add --yes to skip the confirmation prompt in scripts. See the Safety model for the full rules.

Major areas

Section titled “Major areas”
Area Command prefix What you do
Flows ayx one flows List, create, run, validate, import/export, manage permissions
Workflows ayx one workflows List, inspect, copy, and share cloud-native canvas workflows
Plans ayx one plans Orchestrate multi-flow plans, manage schedules, share, import/export
Connections ayx one connections Manage data connections and connector metadata
Job groups ayx one job-groups Run, cancel, inspect, and retrieve results for job groups
Datasets ayx one datasets Browse the One dataset library and inspect dataset details
Output objects ayx one output-objects CRUD for output objects; inspect inputs; convert to Python
Write settings ayx one write-settings Configure where flows write their output data
Webhooks ayx one webhook-flow-tasks Create, inspect, delete, and test webhook-triggered flow tasks
Scheduling ayx one scheduling List schedules, enable and disable them
Identity & users ayx one login / logout / whoami / auth / workspace / person / token / role Sign in/out, inspect identity, and administer workspaces, users, tokens, and roles
Billing ayx one billing Account information and usage exports
Diagnostics ayx one doctor / ayx one inventory Health checks across auth, identity, plans, scheduling, and billing

How --apply keeps you safe

Section titled “How --apply keeps you safe”

Every command that modifies remote state prints a structured dry-run by default — it shows you exactly what request would be sent, then exits. Add --apply to commit.

Terminal window
# Shows what would be deleted; changes nothing
ayx one flows delete <id>


# Actually deletes
ayx one flows delete <id> --apply

For non-interactive automation (CI pipelines, scripts), add --yes to suppress the TTY confirmation prompt.

JSON output

Section titled “JSON output”

Pass --output json for machine-readable output on stdout. --output is a global flag, so it can appear before or after the subcommand:

Terminal window
ayx --output json one flows list

The envelope is { ok, message, timestamp_utc, data } on success; failures also include error_code. Combine with --verbose to get human-readable progress on stderr without polluting stdout.

Targeting a specific environment

Section titled “Targeting a specific environment”

Most commands accept --profile <name> to target a non-default workspace profile (each command’s page notes any exceptions).

Terminal window
ayx one flows list --profile staging
Section titled “Related”