Common tasks

Recipes for everyday work. Read-only commands are safe to run anytime; anything that changes your server is dry-run by default and only commits when you add --apply.

Check that everything’s connected

ayx doctor

Runs config, auth, network, and product checks — without touching remote state.

See your active profile and workspace

ayx whoami

Active profile, account email, workspace, and environment, in one shot.

List flows

ayx --output json one flows list --all

--all pages through every result. Leave it off for just the first page.

Inspect a flow before you touch it

ayx --output json one flows detail <id>

Read-only — returns the flow’s metadata, parameters, and permissions.

Delete a flow, safely

# Dry-run: shows what would happen, deletes nothing
ayx one flows delete <id>

# Commit it
ayx one flows delete <id> --apply

Add --yes to skip the confirmation prompt in scripts.

Back up MongoDB

# Dry-run
ayx mongo backup

# Run it
ayx mongo backup --output-dir /var/backups/ayx --apply

With --apply, ayx records an audit artifact under ${AYX_CONFIG_HOME}/audits/.

Run one command against a different environment

ayx --output json one flows list --profile staging

--profile switches profile for a single run. To change your default for good, use ayx profile use <name>.

Get a telemetry overview

ayx --output json telemetry summary --since 7d --top 10

Running jobs, recent history, top workflows, and errors — in one envelope.

Plan an Alteryx Server upgrade

ayx server upgrade plan --from 2023.1 --to 2024.1

Read-only. Writes a structured upgrade plan you can review before you act.