Command reference

172 commands across 17 groups. Each row gives the command, what it does, its full syntax from the command registry (every positional argument, named parameter and flag) and the role it requires. help <command-name> prints the same syntax inside the CLI.

Inline SQL on JSON output

Most commands return JSON. The CLI ships a compact SQL engine that operates directly on that JSON. Use it on any read command to filter, project, sort, paginate, and transform.

Clause	Form	Notes
`SELECT`	`select id, name, upper(name) as upper_name`	Aliases (with or without `as`), `DISTINCT`, scalar functions, JSON paths.
`FROM`	`from executions` · `from node1.node2`	Flatten nested arrays. `parent.*` pulls all parent fields after flattening.
`WHERE`	`where status != "success" and started > ts("now - 10d")`	Full expression engine: `=, !=, >, >=, <, <=, AND, OR, NOT`, `IS [NOT] NULL`, `LIKE` (case-insensitive), `IN`, `BETWEEN`.
`ORDER BY`	`order by created desc, name asc`	Multi-field, asc/desc. Supports SELECT aliases.
`LIMIT`	`limit 10`	Standard.

Functions

Group	Functions
String	`upper(s)` · `lower(s)` · `startswith(s, prefix)` · `endswith(s, suffix)`
Time arithmetic (epoch ms)	`addSeconds(ts, n)` · `addMinutes(ts, n)` · `addHours(ts, n)` · `addDays(ts, n)`
Parsing	`parseDate(text)` · `parseDate(text, pattern)` · `age(ts)`: "5m ago"
Timestamps	`ts(value)` · `now()` · `date(ts)` · `date_only(ts)` · `time_only(ts)` · `unix(value)`
Relative ts	`ts("now - 1d")` · `ts("now + 12h")` · `ts("now - 15m")` · `ts("now + 20s")` · `ts("now - 50ms")`

Full grammar + complete function list: Built-in SQL in CLI.

Modifiers

Modifier	Effect
`--force`	Allow destructive operations without an interactive prompt.
`--silent`	Suppress normal output. Errors still surface.
`--silent-if-empty`	Suppress output if stdout is null or an empty array.
`--stop-on-error`	Halt the script (or loop) on the first failure.

Confirmation

Roughly 50 commands: every delete-*, every edit-*, every flow run/stop, every agent lifecycle action are flagged as destructive and require --force in scripted runs (or a y at the prompt interactively). Tagged below as (confirms).

Help & info 8 commands

Command	Description
`help`	List commands or get usage for one. Discoverable via the in-UI Command Palette too. `help [full=false\|true] [asJson=true\|false]`
`version`	CLI version + build info. `version [extended]`
`whoami`	Current user, role, tenant.
`health`	Node-level status, memory, thread pools, service availability.
`update`	Self-update the CLI engine (where supported). Super Admin
`get-license-info`	License tier, seats, usage caps. Super Admin
`list-app-releases`	Available platform releases. `list-app-releases [limit]`
`print`	Print a literal value (useful in scripts with capture vars). `print '<template>'`

Flows: define & inspect 11 commands

Command	Description
`add-flow`	Create a flow from a JSON definition. `add-flow '<flowJson>'`Editor
`edit-flow`	Update an existing flow from a JSON definition. (confirms) `edit-flow <flowId> '<flowJson>'`Editor
`delete-flow`	Delete a flow by id. Optional `deleteConnections`, `deleteSchedules` flags. (confirms) `delete-flow <flowId> [deleteConnections=true\|false] [deleteSchedules=true\|false]`Editor
`get-flow`	Return the flow JSON by id. `get-flow <id\|name>`Editor
`list-flows`	List flows. Apply `where` + SQL clauses for filtering & projection. `list-flows [scope=all]`Operator
`flow-search`	Search a flow hierarchy (including nested flows) for a string. Returns matching flow IDs and per-flow match counts. `flow-search <flowId> '<search string>'`
`find-flow-schedules`	List schedules associated with a specific flow. `find-flow-schedules <flow-id>`Administrator
`flow-usage`	Where this flow is referenced: other flows, schedules, agents. `flow-usage <flowId>`Editor
`inspect-flow`	Static inspection. Returns severity-ranked issues with suggestions. `inspect-flow <flowId>`Editor
`flow-documentation`	Generate Markdown documentation for a flow. `flow-documentation <flow-id>`Editor
`flow-findings`	Saved inspection findings across flows, filterable by severity, flow and tenant: `flow-findings [status=critical\|major\|medium\|minor\|info] [flowId=<id>] [flowName=<text>] [tenants=<ids\|all>] [top=<N>]`. `flow-findings [tenants=<id1,id2,...\|all>] [status=<critical\|major\|medium\|minor\|info>] [flowId=<id>] [flowName=<text>] [tenantName=<text>] [top=<N>]`Viewer

Flows: run & monitor 14 commands

Command	Description
`run-flow`	Run a flow by id. Optional `sync`, `debug`, retry/email/timeout flags + arbitrary `name=value` flow parameters. (confirms) `run-flow <flowId> [sync=false\|true] [waitIfRunning=true\|false] [force=true\|false] [allowParallel=false\|true] [debug=true\|false] [logStep=100] [emailOnSuccess=true\|false] [emailOnFailure=true\|false] [emailOnLastFailure=true\|false] [emailMetrics=true\|false] [emails=<list>] [expectedTime=<minutes>] [stopTime=<minutes>] [returnErrorCode=true\|false] [disableExecutionNotifications=false\|true] [repeatExpectedTimeNotifications=false\|true] [checkAgentFlow=true\|false] [anyFlowParameter=value ...]`Operator
`run-flow-by-name`	Run a flow by name. Optional `tenant=<name>`. (confirms) `run-flow-by-name <flowName> [tenant=<tenantName>] [sync=false\|true] [debug=true\|false] [allowParallel=false\|true] [logStep=100] [returnErrorCode=true\|false] [emailOnSuccess=true\|false] [emailOnFailure=true\|false] [emailOnLastFailure=true\|false] [emailMetrics=true\|false] [emails=<list>] [expectedTime=<minutes>] [stopTime=<minutes>] [disableExecutionNotifications=false\|true] [repeatExpectedTimeNotifications=false\|true] [anyFlowParameter=value ...]`Operator
`run-agent-flow`	Run a flow on a specific on-prem agent. (confirms) `run-agent-flow <agentId> <flowId> [description=text] [verify=true\|false]`Administrator
`stop-flow`	Graceful stop of a running flow. (confirms) `stop-flow <id>`Operator
`stop-agent-flow`	Stop a running flow on a specific agent. (confirms) `stop-agent-flow <agentId> <flowId> [verify=true\|false]`Administrator
`dbt`	Run a saved dbt flow and read what it produced: `dbt execute <flow>`, `dbt <command> <flow> [select=…] [exclude=…] [vars=…]`, `dbt results <flow>`, `dbt artifacts <flow>`, `dbt download-artifact <flow> <artifact>`. Operator role. `dbt execute <flow> [runtimeParameter=value ...] \| dbt <command> <flow> [select=...] [exclude=...] [vars=...] [macro=...] [args=...] \| dbt results <flow> [execution=last] \| dbt artifacts <flow> [execution=last] \| dbt download-artifact <flow> <artifact> [execution=last] [invocation=...]`Operator
`get-flow-status`	Latest run status for a flow. `get-flow-status <id> [status]`Operator
`list-running-flows`	Currently in-flight flows. SQL-friendly: filter by start time, tenant, etc. Operator
`tail-flow-log`	Stream the run log for an in-flight execution. `tail-flow-log flowId=<id>\|flowName=<name> auditId=<id\|last\|last-error\|last-success\|last-warning> [lines=100]`Operator
`flow-executions`	Executions for a date or offset, current tenant. `flow-executions [date=<YYYY-MM-DD>] [offset=<0-30>] [tenantId=<id>] [includeMetrics=true\|false]`Administrator
`flow-executions-aggregated`	Executions across multiple tenants. `tenants=all` for everything. `flow-executions-aggregated tenants=<id1,id2,...\|all> [date=<YYYY-MM-DD>] [offset=<0-30>] [includeMetrics=true\|false]`Super Admin
`flows-suspend`	Suspend new executions (scheduler + manual). Running flows continue. (confirms) `flows-suspend [--persistent]`Super Admin
`flows-suspend-force`	Suspend AND attempt to stop running flows. Emergency stop. (confirms) `flows-suspend-force [--persistent]`Super Admin
`flows-resume`	Re-enable scheduler and manual executions. (confirms) Super Admin

Connections 8 commands

Payloads are metadata-driven: connectionType values like connection.db.postgres and the properties keys come from the platform's connector library. Easiest discovery: build one in the UI, then get-connection <id> to see the exact shape.

Command	Description
`add-connection`	Create from a JSON payload (single-quoted). `add-connection '<connection-json>'`Editor
`edit-connection`	Update from a JSON payload. (confirms) `edit-connection <id> '<connection-json>'`Editor
`delete-connection`	Delete by id. (confirms) `delete-connection <id>`Editor
`get-connection`	Return the connection JSON by id (credentials redacted). `get-connection <id\|name>`Editor
`list-connections`	List connections. SQL clauses supported. `list-connections [scope=all]`Editor
`build-default-connection`	Build a connection template from a connectorType descriptor. Accelerates IaC provisioning. `build-default-connection <connection-type>`Editor
`test-connection`	Verify the connection (engine or specific agent). `test-connection <id> [agent=<agent-id>] [action=<agent-action-id>]`Editor
`find-connection-usage`	List flows that reference this connection. `find-connection-usage <connection-id>`Editor

Formats 7 commands

Command	Description
`add-format`	Create a format from a JSON payload. `add-format '<format-json>'`Editor
`edit-format`	Update a format. (confirms) `edit-format <id> '<format-json>'`Editor
`delete-format`	Delete by id. (confirms) `delete-format <id>`Editor
`get-format`	Return the format JSON. `get-format <id>`Editor
`list-formats`	List formats. SQL-friendly. `list-formats [scope=all]`Editor
`build-default-format`	Build a format from descriptor defaults for the given format type. `build-default-format <format-type>`Editor
`find-format-usage`	List flows that use this format. `find-format-usage <format-id>`Editor

Schedules 8 commands

Command	Description
`add-schedule`	Create from a JSON payload. (confirms) `add-schedule '<schedule-json>'`Administrator
`edit-schedule`	Update from a JSON payload. (confirms) `edit-schedule <id> '<schedule-json>'`Administrator
`delete-schedule`	Delete by id. (confirms) `delete-schedule <id>`Administrator
`get-schedule`	Return the schedule JSON. `get-schedule <id>`Administrator
`list-schedules`	List schedules. SQL-friendly: filter by `enabled`, etc. `list-schedules [scope=all]`Administrator
`enable-schedule`	Enable a schedule. (confirms) `enable-schedule <schedule-id>`Administrator
`disable-schedule`	Disable a schedule. (confirms) `disable-schedule <schedule-id>`Administrator
`is-schedule-enabled`	Boolean check. `is-schedule-enabled <schedule-id>`Administrator

Macros 5 commands

Command	Description
`add-macro`	Create a macro. `add-macro '<json>'`Editor
`edit-macro`	Update. (confirms) `edit-macro <id> '<json>'`Editor
`delete-macro`	Delete by id. (confirms) `delete-macro <id>`Administrator
`get-macro`	Return the macro JSON. `get-macro <id>`Editor
`list-macros`	List macros. Editor

Webhooks 7 commands

Webhooks are outbound: Etlworks POSTs to your URL when listed flow events fire.

Command	Description
`add-webhook`	Subscribe to flow events. (confirms) `add-webhook '<webhook-json>'`Administrator
`edit-webhook`	Update a subscription. (confirms) `edit-webhook <id> '<webhook-json>'`Administrator
`delete-webhook`	Unsubscribe. (confirms) `delete-webhook <id>`Administrator
`get-webhook`	Return the webhook JSON. `get-webhook <id>`Administrator
`list-webhooks`	List subscriptions. `list-webhooks [scope=all]`Administrator
`get-webhook-event`	One outbound delivery attempt + its HTTP response. `get-webhook-event <webhook-id> <event-id>`Administrator
`get-webhook-events`	List recent delivery attempts. `get-webhook-events <webhook-id>`Administrator

Tags & search 5 commands

Command	Description
`list-tags`	All tags in the current account. `global=true` for all tenants. `list-tags [global=true\|false] [include=types] [exclude=types]`Editor
`update-tags`	Rename / delete tags in the current account. (confirms) `update-tags '<json>'`Administrator
`update-all-tags`	Same operation across all tenants (super admin). (confirms) `update-all-tags '<json>'`Super Admin
`update-tenant-tags`	Tag operations scoped to a specific tenant. (confirms) `update-tenant-tags <tenantId> '<json>'`Super Admin
`search`	Plain-English search across flows, connections, formats, schedules, and other objects. `search '<keywords>'`

Users & tenants 8 commands

Command	Description
`add-user`	Create a user from a JSON definition. `add-user '<userJson>' [noInvite=<true\|false>]`Administrator
`edit-user`	Update. (confirms) `edit-user <userId> '<userJson>'`Administrator
`get-user`	Return the user record. `get-user <id>`Administrator
`list-users`	Users in the current tenant. Administrator
`add-tenant`	Create a tenant (super admin). `add-tenant '<tenantJson>'`Super Admin
`edit-tenant`	Update tenant settings. (confirms) `edit-tenant <tenantId> '<tenantJson>'`Super Admin
`get-tenant`	Return the tenant record. `get-tenant <id>`Super Admin
`list-tenants`	Tenants visible to the calling user. Super Admin

History, diff & revert 18 commands

Every CRUD-ed resource keeps version history. Pair *-history with *-history-diff to inspect changes between specific versions or against the current. Since 10.0.0, revert-* restores a specific revision and saves it immediately.

Command	Description
`flow-history`	Past versions of a flow. `flow-history <flowId>`Editor
`flow-history-diff`	Diff two flow versions: `flow-history-diff <flowId> from=current to=last`. `flow-history-diff <flowId> from=<uuid\|current> to=<uuid\|last>`Editor
`connection-history`	Past versions of a connection. `connection-history <connection-id>`Editor
`connection-history-diff`	Diff two connection versions. `connection-history-diff <connection-id> <from-uuid\|current> <to-uuid\|last>`Editor
`format-history`	Past versions of a format. `format-history <id>`Editor
`format-history-diff`	Diff two format versions. `format-history-diff <id> <from-uuid\|current> <to-uuid\|last>`Editor
`schedule-history`	Past versions of a schedule. `schedule-history <schedule-id>`Administrator
`schedule-history-diff`	Diff two schedule versions. `schedule-history-diff <schedule-id> <from-uuid\|current> <to-uuid\|last>`Administrator
`macro-history`	Past versions of a macro. `macro-history <id>`Editor
`macro-history-diff`	Diff two macro versions. `macro-history-diff <id> <from-uuid\|current> <to-uuid\|last>`Editor
`agent-history`	Past versions of an agent definition. `agent-history <agentId>`Administrator
`agent-history-diff`	Diff two agent versions. `agent-history-diff <agentId> from=<uuid\|current> to=<uuid\|last>`Administrator
`revert-flow`	Restore a flow to a revision: `revert-flow <flowId> <revision-uuid>`. (confirms) `revert-flow <id> <revision-uuid> [confirm=<token>\|--force]`Administrator
`revert-connection`	Restore a connection to a revision. (confirms) `revert-connection <id> <revision-uuid> [confirm=<token>\|--force]`Administrator
`revert-format`	Restore a format to a revision. (confirms) `revert-format <id> <revision-uuid> [confirm=<token>\|--force]`Administrator
`revert-schedule`	Restore a schedule to a revision, including its saved enabled state and scheduling configuration. (confirms) `revert-schedule <id> <revision-uuid> [confirm=<token>\|--force]`Administrator
`revert-agent`	Restore an Agent's saved configuration to a revision. Does not change the software installed on the host. (confirms) `revert-agent <id> <revision-uuid> [confirm=<token>\|--force]`Administrator
`revert-macro`	Restore a macro to a revision. (confirms) `revert-macro <id> <revision-uuid> [confirm=<token>\|--force]`Administrator

Revert rules

Run the matching *-history command first: it returns each revision's uuid, modification time, author and message.
Revert takes the artifact ID and the exact revision UUID. Names are not accepted, and current and last are selectors for *-history-diff only.
Artifact IDs are positive integers. Agent IDs are UUIDs.
The revert saves immediately: no editor, no separate Save. The change comment is Reverted to revision <uuid> via CLI, and existing history is kept.
Only the selected artifact is restored. Connections, formats and child flows it references are not reverted, and a missing dependency can block the save.
Tenant Administrator for artifacts in the current tenant, or Super Admin for any artifact by ID. Being able to see a shared artifact does not grant permission to revert it.
First call returns a confirmation challenge; repeat it with confirm=<token>. --force skips only that prompt, never permissions or validation. These commands do not run in parallel-command mode.

CLI

flow-history 123
revert-flow 123 973d824c-3d0f-4d9f-8a56-decf8f08ebce
revert-flow 123 973d824c-3d0f-4d9f-8a56-decf8f08ebce confirm=<returned-token>

Recycle Bin 10 commands

Added in 10.0.0. Deleting a flow, connection, format, listener or Agent configuration moves it to the Recycle Bin; these commands find it and bring it back. Unlike revert-*, which picks a revision of a live artifact, restore-* recovers a deleted one.

Command	Description
`list-deleted-flows`	Deleted flows with restore-eligibility metadata. Administrator
`list-deleted-connections`	Deleted connections. Administrator
`list-deleted-formats`	Deleted formats. Administrator
`list-deleted-listeners`	Deleted listeners. Administrator
`list-deleted-agents`	Deleted Agent configurations. Administrator
`restore-flow`	Restore a deleted flow: `restore-flow <name\|id>`. (confirms) `restore-flow <name\|id> [confirm=<token>\|--force] (or id=<id> / name=<name>)`Administrator
`restore-connection`	Restore a deleted connection. (confirms) `restore-connection <name\|id> [confirm=<token>\|--force] (or id=<id> / name=<name>)`Administrator
`restore-format`	Restore a deleted format. (confirms) `restore-format <name\|id> [confirm=<token>\|--force] (or id=<id> / name=<name>)`Administrator
`restore-listener`	Restore a deleted listener. (confirms) `restore-listener <name\|id> [confirm=<token>\|--force] (or id=<id> / name=<name>)`Administrator
`restore-agent`	Restore a deleted Agent configuration. Does not reinstall anything on a host. (confirms) `restore-agent <name\|id> [confirm=<token>\|--force] (or id=<id> / name=<name>)`Administrator

Listing

The list-deleted-* commands take no arguments, are read-only and need no confirmation. Each returns a JSON array of objects with type, id, name, tenantId (null means a global artifact), subType, deleted (Unix epoch milliseconds), deletedBy, canRestore and restoreBlockedReason. Blocked items stay visible with their reason, and canRestore is preliminary metadata eligibility: a restore still runs dependency and authorization checks and can fail. An empty Recycle Bin is [] with exit code 0. Connections and listeners are listed separately, and deleted schedules and standalone macros are not covered.

Restoring

A positional selector matches either a name or an ID. Names match exactly and case-insensitively, not as substrings: quote names with spaces, as in restore-flow "Daily customer import".
Use id=<id> or name=<name> when an artifact's name is itself numeric.
Several matches fail without restoring anything; the error lists the matching IDs and tenant IDs so you can repeat with an explicit id=.
Supported missing dependencies are recovered and existing ones reused, so restoring a flow can bring back more than the flow.
The response carries status and the restored, reused and blocked lists, and never artifact definitions or credentials.
Tenant Administrator within the current tenant, or Super Admin across tenants. Same confirmation and --force behavior as revert-*, and no parallel-command mode.
There is no restore-schedule or standalone restore-macro: the Recycle Bin does not track those as top-level recovery types.

CLI

list-deleted-flows
restore-flow id=42
restore-flow id=42 confirm=<returned-token>

Export, import & copy 7 commands

Move flows, connections and formats between environments or tenants through dump files in local storage. Relative paths resolve under app.data. All seven need Editor rights on what they touch.

Command	Description
`export-flows`	Export all or selected flows to a dump file: `export-flows <file> [<id\|name> …] [excludeCredentials=true\|false]`. `export-flows <file> [<id\|name> ...] [excludeCredentials=true\|false]`Editor
`export-connections`	Same for connections. `export-connections <file> [<id\|name> ...] [excludeCredentials=true\|false]`Editor
`export-formats`	Same for formats. `export-formats <file> [<id\|name> ...] [excludeCredentials=true\|false]`Editor
`import-flows`	Import every flow in a dump file and return the import report: `import-flows <file> [collision=Add\|Replace\|Keep] [message="text"] [tags=tag1,tag2] [noCredentials=true\|false]`. (confirms) `import-flows <file> [collision=Add\|Replace\|Keep (default Add)] [message="text"] [tags=tag1,tag2] [noCredentials=true\|false (default false)]`Editor
`import-connections`	Same for connections. (confirms) `import-connections <file> [collision=Add\|Replace\|Keep (default Add)] [message="text"] [tags=tag1,tag2] [noCredentials=true\|false (default false)]`Editor
`import-formats`	Same for formats. (confirms) `import-formats <file> [collision=Add\|Replace\|Keep (default Add)] [message="text"] [tags=tag1,tag2] [noCredentials=true\|false (default false)]`Editor
`copy-flow`	Copy a flow with all its connections and formats, within a tenant or between tenants: `copy-flow <flowId\|name> [from-tenant=…] [to-tenant=…] [collision=Add\|Keep\|Replace] [importSchedules=true\|false] [excludeCredentials=true\|false]`. Credentials are copied by default so the copy runs. Cross-tenant copies need Super Admin. `copy-flow <flowId\|name> [to-tenant=<id\|name\|current> (default current)] [from-tenant=<id\|name\|current> (default current)] [collision=Add\|Keep\|Replace (default Add)] [importSchedules=true\|false (default false)] [excludeCredentials=true\|false (default false)]`Editor

Data & SQL 7 commands

Inline SQL operations on the data behind any connection, plus JavaScript for arbitrary computation.

Command	Description
`data-run-sql`	Execute SQL on a connection. `data-run-sql connectionId=<id> [object=<name>] [formatId=<id>] [sql="<statement>"] [script=true\|false] [agent=<agentId>]`. Works against SQL databases, files, APIs, queue connections. `data-run-sql connectionId=<id> [object=<name>] [formatId=<id>] [sql="<statement>"] [script=true\|false] [agent=<agentId>] [action=<agentActionId>]`Editor
`data-list-objects`	List objects (tables, views, files, endpoints) exposed by a connection. `data-list-objects connectionId=<id> [formatId=<id>]`Editor
`data-list-fields`	List the fields/columns of one object on a connection. `data-list-fields connectionId=<id> object=<name> [formatId=<id>]`Editor
`data-get-raw`	Return raw, untransformed data from a connection + format. `connectionId`, `formatId`, `object` required. `data-get-raw connectionId=<id> object=<name> formatId=<id> [agent=<agentId>] [action=<agentActionId>]`Editor
`get-sql-history`	Past SQL executed against a given connection. `get-sql-history <connectionId>`Editor
`execute-code`	Execute JavaScript inline. `execute-code code="<js>" [params='{"k":"v"}'] [java=true]`. Calculations, data transforms, custom logic. `execute-code code="<javascript>" [params='{"key":"value"}'] [java=true]`
`list-functions`	The platform's built-in transformation function catalog: signatures + descriptions. Editor

Agents (on-prem workers) 16 commands

Manage on-prem CLI workers that execute flows on customer infrastructure. Not the AI agent, that's documented separately at /dev/ai/.

Command	Description
`add-agent`	Create an agent from a JSON definition. `add-agent '<agentJson>'`Administrator
`edit-agent`	Update an agent. (confirms) `edit-agent <agentId> '<agentJson>'`Administrator
`delete-agent`	Delete by id. (confirms) `delete-agent <agentId>`Administrator
`get-agent`	Return the agent record. `extended=true` includes properties, ping, flows. `get-agent <agentId> [extended=false\|true]`Administrator
`get-agent-status`	Status & metrics for an agent. `get-agent-status <agentId>`Administrator
`list-agents`	List agents. SQL-friendly: filter by enabled, by ping age, etc. `list-agents [scope=all] [extended=false\|true]`Administrator
`list-agent-releases`	Available agent build versions. `list-agent-releases [limit]`
`enable-agent`	Enable. (confirms) `enable-agent <agentId>`Administrator
`disable-agent`	Disable. (confirms) `disable-agent <agentId>`Administrator
`start-agent`	Start a stopped agent. (confirms) `start-agent <agentId> [verify=true\|false]`Administrator
`stop-agent`	Stop a running agent. (confirms) `stop-agent <agentId> [verify=true\|false]`Administrator
`restart-agent`	Restart. (confirms) `restart-agent <agentId> [verify=true\|false]`Administrator
`update-agent`	Roll the agent to the latest build. (confirms) `update-agent <agentId> [version=<version>] [verify=true\|false]`Administrator
`set-agent-max-ram`	Adjust max heap. (confirms) `set-agent-max-ram <agentId> <maxRamMb> [verify=true\|false]`Administrator
`add-agent-action`	Queue an action against an agent and return the receipt. (confirms) `add-agent-action <agentId> '<agentActionJson>'`Administrator
`cancel-agent-action`	Cancel a queued action. (confirms) `cancel-agent-action <agentId> <actionId>`Administrator

Observability & system 28 commands

Command	Description
`metrics`	Time-series metrics (current tenant). `metrics [tenantId=<id>]`Administrator
`metrics-aggregated`	Time-series across multiple tenants. `metrics-aggregated tenants=<id1,id2,...\|all>`Super Admin
`etl-threads`	ETL execution threads across all nodes: parent & child threads. Super Admin
`running-tasks`	Tasks in-flight on this node. `running-tasks [tenantId=<id>]`Operator
`running-tasks-aggregated`	Tasks across the cluster. (confirms) `running-tasks-aggregated tenants=<id1,id2,...\|all>`Super Admin
`resource-config`	Resource configuration snapshot. Super Admin
`resource-summary`	Resource utilization summary. Super Admin
`resource-executions`	Executions broken out by resource. `resource-executions [from=<ISO-8601>] [to=<ISO-8601>] [flowId=<id>] [tenants=<id1,id2,...>] [top=<N>]`Super Admin
`resource-bottlenecks`	Detected bottlenecks ranked by impact. `resource-bottlenecks [from=<ISO-8601>] [to=<ISO-8601>] [tenants=<id1,id2,...>] [top=<N>]`Super Admin
`resource-threads`	Thread-pool utilization. `resource-threads [from=<ISO-8601>] [to=<ISO-8601>] [flowId=<id>] [tenants=<id1,id2,...>] [nodeId=<node>] [rootsOnly=<true\|false>] [top=<N>]`Super Admin
`resource-timeline`	Resource usage over time. `resource-timeline [from=<ISO-8601>] [to=<ISO-8601>] [nodeId=<node>] [metric=<cpu\|memory\|cpu+memory\|heap\|threads\|disk\|data-disk>] [resolution=<auto\|1m\|15m\|1h\|fine\|medium\|coarse>]`Super Admin
`resource-top-flows`	Flows consuming the most resources. `resource-top-flows [from=<ISO-8601>] [to=<ISO-8601>] [tenants=<id1,id2,...>] [metric=<cpu\|memory\|allocation>] [top=<N>]`Super Admin
`get-audit-records`	Audit log entries with optional filters (resourceType, userId, action, since). `get-audit-records [fromDate=...] [toDate=...] [fromTime=...] [toTime=...] [method=...] [parameters=...] [exception=...] [user=...] [status=success\|error] [duration=<ms>] [clientIp=...]`Administrator
`list-errors`	Recent error events. `list-errors [top=20] [hours=24] [flowId=123\|flowName=<name>] [warnings=true]`Super Admin
`disk-usage-summary`	Total / free / used space for `app.data` with breakdown by tenant / directory. Super Admin
`find-files`	Find files under `app.data` by name, extension, size, modification date. (confirms) `find-files [name=*.log] [ext=.csv] [path=logs] [size=>10MB] [modified=>2026-01-01] [top=50] [sort=size\|name\|modified] [delete=true]`Super Admin
`list-large-files`	Files exceeding a size threshold. `list-large-files [top=20] [min_size=1MB] [path=logs] [ext=.log]`Super Admin
`list-listeners`	Listener connections (HTTP / Kafka / SQS / MQTT) currently registered. `list-listeners [scope=all]`Editor
`list-messages`	Inbound listener messages. Administrator
`list-messages-filtered`	Filter messages by message body, format, status. `list-messages-filtered [sender=<name>] [size=<n>] [sizeType=<Byte\|KB\|MB>] [comparator=< <\|=\|> >] [fromDate=<epoch>] [toDate=<epoch>] [status=<s>] [format=<fmt>] [message=<substring>] [scheduleName=<name>]`Administrator
`get-message`	Pull the full body of a single message. `get-message <messageId>`Administrator
`send-mail`	Send an email through the platform's mailer. `send-mail to="recipient@example.com" subject="Subject line" body="Email body (HTML supported)"`Operator
`tail-app-log`	Last lines of the application log, on one node or all: `tail-app-log [node=<nodeId\|all>] [lines=<1-100000>]`. Application nodes only, use `tail-flow-log` for executions. Super Admin. `tail-app-log [node=<nodeId\|all>] [lines=<1-100000>]`Super Admin
`refresh-license`	Refresh license properties on all live application nodes, after a renewal or plan change, without a restart. Super Admin. Super Admin
`ai-usage-report`	AI token usage for a day or a date range, broken down to find what drove a spike: `ai-usage-report <from-date> [to-date] [by=user\|session\|model\|day]`, or `ai-usage-report export=<session-id>` for a transcript download link. Super Admin. `ai-usage-report <from-date> [to-date] [by=user\|session\|model\|day] OR ai-usage-report export=<session-id> [format=csv\|json\|md] (dates YYYY-MM-DD; single date = that day; range inclusive; export returns an authenticated transcript download link)`Super Admin
`resource-incidents`	Resource Usage incident windows (CPU, RAM, disk) with the flow evidence captured during each: `resource-incidents [from=…] [to=…] [status=open\|resolved\|interrupted] [resource=…] [nodeId=…] [top=<N>]`. Defaults to the last 6 hours. `resource-incidents [from=<ISO-8601>] [to=<ISO-8601>] [nodeId=<node>] [status=<open\|resolved\|interrupted>] [resource=<cpu\|ram\|disk\|cpu_ram\|cpu_disk\|ram_disk\|cpu_ram_disk>] [top=<N>]`Super Admin
`resource-incident-impact`	Execution impact of one incident: baseline and incident windows, impact indicators, and the most affected flows. `resource-incident-impact incidentId=<id>`. `resource-incident-impact incidentId=<id> [tenants=<id1,id2,...>]`Super Admin
`redis-persist-for-backup`	Persist Redis state to disk (BGSAVE) before a backup or migration, and wait until it completes. (confirms) Super Admin

Diagnostics 5 commands

Added in 10.0.8. Super Admin only. Each command reads the ETL engine node that answers the request, not the whole cluster and not Integration Agents, and needs an up-to-date engine.

Command	Description
`thread-dump`	Read-only live thread dump of the engine JVM: states, full stacks, locks and lock owners. `--name=<substring>` narrows to an execution’s threads, `--thread-id` to one thread; pages with `--limit` and `--after-thread-id`. Use it for stalls. `thread-dump [--name=<thread-name-substring>] [--thread-id=<id>] [--limit=20] [--after-thread-id=<id>]`Super Admin
`core-dump`	Write an HPROF heap dump on the engine and return its path. Can pause the JVM and uses disk space. (confirms) Super Admin
`analyze-heap-dump`	Analyze a heap dump in an isolated, bounded JVM on its node: class histogram, largest retained objects, GC-root paths and thread stacks, never payload values. Starts an asynchronous job: `analyze-heap-dump <path> [--top=20] [--histogram-only] [--wait=20]`. (confirms) `analyze-heap-dump <engine-hprof-path\|job-id> [--top=20] [--histogram-only] [--wait=20]`Super Admin
`heap-analysis-status`	Poll a heap analysis job for its partial or final report: `heap-analysis-status <job-id> [--wait=20]`. `heap-analysis-status <job-id> [--wait=20]`Super Admin
`cdc-buffers`	Live CDC queue occupancy, estimated bytes, producer backpressure and destination flush timing on the responding engine node. Read-only. Super Admin

Reading the syntax

<value> is required, [value] is optional, a|b is a choice, and name=value is a named parameter. The role is the one the registry declares for the command; your tenant’s permissions still apply. Every command returns JSON unless it says otherwise, so any read command can be followed by the inline SQL clauses to filter and shape its output. The syntax on this page is taken from the command registry of the current release.