Skip to content
ayx-rsv0.15.0

Diagnostics

Two commands give you a quick read on the health of your Alteryx One environment: ayx one doctor and ayx one inventory. Run these first when something seems off, or wire them into a monitoring script.

Quick reference

Section titled “Quick reference”
Command What it does
ayx one doctor auth Verify authentication credentials are valid
ayx one doctor discover Probe API discoverability
ayx one doctor identity Check identity surface health
ayx one doctor plans Check plans surface health
ayx one doctor scheduling Check scheduling surface health
ayx one doctor billing Check billing surface health
ayx one inventory Asset inventory across the workspace

Running a full health check

Section titled “Running a full health check”

Run all doctor subcommands in sequence to get a broad picture:

Terminal window
ayx one doctor auth
ayx one doctor discover
ayx one doctor identity
ayx one doctor plans
ayx one doctor scheduling
ayx one doctor billing

Each check is independent. A failure in one does not block the others.

Authentication check

Section titled “Authentication check”

Start here when commands return 401 or credential errors:

Terminal window
ayx one doctor auth

Add --profile <name> to test a specific profile:

Terminal window
ayx one doctor auth --profile staging

Discovery check

Section titled “Discovery check”

discover probes the API to confirm the Alteryx One endpoint is reachable and returning expected metadata:

Terminal window
ayx one doctor discover

Identity, plans, scheduling, and billing checks

Section titled “Identity, plans, scheduling, and billing checks”

These targeted checks verify that specific API surfaces are healthy:

Terminal window
ayx one doctor identity
ayx one doctor plans
ayx one doctor scheduling
ayx one doctor billing

Run ayx one doctor billing before investigating billing data issues — it confirms the billing API is reachable before you try an export.

Inventory

Section titled “Inventory”

inventory is a standalone command (not under doctor) that provides a broader view:

Terminal window
# Asset inventory across the workspace
ayx one inventory

Accepts --profile <name>.

The old top-level status command under one — and its nested equivalent from the former platform group — have both been removed entirely, with no direct successor. Looking for Alteryx Server health instead? That’s ayx server api status — a separate command outside the one surface.

JSON output

Section titled “JSON output”

All diagnostic commands support --output json:

Terminal window
ayx --output json one doctor auth
ayx --output json one inventory

The envelope is { ok, message, timestamp_utc, data } on success; failures also include error_code. Pipe to jq for scripting:

Terminal window
ayx --output json one doctor auth | jq '.ok'
Section titled “Related”