Articles in this section

CLI Commands Reference

  • Updated
Follow

Overview

The Etlworks CLI provides a unified, scriptable interface for managing every part of the Etlworks platform. It allows users to inspect, modify, and automate objects such as connections, formats, flows, schedules, tenants, users, agents, listeners, messages, data assets, SQL queries, audit logs, system metrics, and runtime controls.

This reference lists all available CLI commands, grouped by functional area.

For each command you will find:

  • Command name

  • Usage

  • Description

  • Required role (at and up) or all roles

  • Whether confirmation is required

  • Whether parallel execution is allowed

The reference is intended for ETL developers, data engineers, DevOps teams, support engineers, and administrators who use the CLI for automation, operational control, troubleshooting, and large multi-step tasks that are difficult to perform through the UI alone.

Passing Parameters to CLI Commands

CLI commands support positional and named parameters.

  • Positional parameters are passed in order, without names.

  • Named parameters use the format name=value.

If a parameter contains spaces, special characters, or structured data such as JSON, it must be enclosed in single quotes, for example:

print '{ "id": 10, "name": "Sample" }'

Named parameters follow the same rule:

connection='{ "status": "active" }'

Both single and double quotes can be escaped inside a quoted value. This allows you to preserve quotes inside JSON or text:

print '{ "message": "He said \"hello\"" }'
print "{ 'path': 'c:\\\\data\\\\file.txt' }"

If quoting is correct, the CLI will treat the entire payload as a single parameter, regardless of whitespace or internal punctuation.

Commands

Managing Flows

add-flow

Usage:

add-flow '<flowJson>'

Description: Creates a new flow from the provided JSON definition (same structure as REST).

Role: Editor

Confirmation: no

Allow parallel: yes

delete-flow

Usage:

delete-flow <flowId> [deleteConnections=true|false] [deleteSchedules=true|false]

Description: Deletes a flow by ID. Supports deleteConnections and deleteSchedules flags. Requires confirmation.

Role: Editor

Confirmation: yes

Allow parallel: yes

edit-flow

Usage:

edit-flow <flowId> '<flowJson>'

Description: Updates an existing flow using the provided JSON definition. Requires confirmation.

Role: Editor

Confirmation: yes

Allow parallel: yes

get-flow

Usage:

get-flow <id>

Description: Retrieve a flow definition by ID, including metadata, mappings, transformations, and nested flows

Role: Editor

Confirmation: no

Allow parallel: yes

list-flows

Usage:

list-flows [scope=all]

Description: List flows. Use scope=all to list all flows, regardless of tenant if permitted. Default scope returns flows accessible to the current tenant.

Role: Operator

Confirmation: no

Allow parallel: yes

run-flow

Usage:

run-flow <flowId> [sync=false|true] [allowParallel=false|true] 
  [waitIfRunning=true|false] [force=true|false] [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] [checkAgentFlow=true|false]

Description: Runs a flow by ID. Supports all parameters available in the REST runFlow API.

Role: Operator

Confirmation: yes

Allow parallel: yes

run-flow-by-name

Usage:

run-flow-by-name <flowName>
  [tenant=<tenantName>] [sync=false|true] [allowParallel=false|true]
  [debug=true|false] [logStep=100]
  [returnErrorCode=true|false] [emailOnSuccess=true|false] [emailOnFailure=true|false]
  [emailOnLastFailure=true|false] [emailMetrics=true|false] [emails=<list>]
  [expectedTime=<minutes>] [stopTime=<minutes>]

Description: Runs a flow by name (and optional tenant).

Role: Operator

Confirmation: no

Allow parallel: yes

stop-flow

Usage:

stop-flow <id>

Description: Attempts to stop a running flow with the given ID. Use –force to skip confirmation.

Role: Operator

Confirmation: yes

Allow parallel: yes

flow-history

Usage:

flow-history <flowId>

Description: Returns the change history for the given flow.

Role: Editor

Confirmation: no

Allow parallel: yes

flow-history-diff

Usage:

flow-history-diff <flowId>
  from=<uuid|current> to=<uuid|last>

Description: Returns a diff between two versions of the flow history.

Role: Editor

Confirmation: no

Allow parallel: yes

flow-usage

Usage:

flow-usage <flowId>

Description: Returns where the flow is referenced in other flows, schedules, and agents.

Role: Editor

Confirmation: no

Allow parallel: yes

inspect-flow

Usage:

inspect-flow <flowId>

Description: Inspects a flow for potential performance and structural issues.

Role: Editor

Confirmation: no

Allow parallel: yes

flow-documentation

Usage:

flow-documentation <flow-id>

Description: Generate documentation for the specified flow.

Role: Editor

Confirmation: no

Allow parallel: yes

list-running-flows

Usage:

list-running-flows

Description: Displays all flows that are currently running.

Role: Operator

Confirmation: no

Allow parallel: yes

running-tasks

Usage:

running-tasks [tenantId=<id>]

Description: Return the list of running flow tasks for the current tenant, or for a specific tenant if tenantId is provided.

Role: Operator

Confirmation: no

Allow parallel: yes

running-tasks-aggregated

Usage:

running-tasks-aggregated tenants=<id1,id2,…|all>

Description: Return aggregated running flow tasks across multiple tenants. When tenants=all is supplied, the command returns results for all active tenants.

Role: Super Admin

Confirmation: yes

Allow parallel: yes

flow-executions

Usage:

flow-executions [date=<YYYY-MM-DD>]
  [offset=<0-30>] [tenantId=<id>] [includeMetrics=true|false]

Description: Return the list of flow executions for a specific day (date or offset) for a tenant.

Role: Administrator

Confirmation: no

Allow parallel: yes

flow-executions-aggregated

Usage:

flow-executions-aggregated tenants=<id1,id2,…|all>
  [date=<YYYY-MM-DD>] [offset=<0-30>] [includeMetrics=true|false]

Description: Return aggregated flow executions across multiple tenants.

Role: Super Admin

Confirmation: no

Allow parallel: yes

flows-suspend

Usage:

flows-suspend

Description: Suspends new flow executions. Scheduler and manual executions are blocked. Running flows continue.

Role: Super Admin

Confirmation: yes

Allow parallel: no

flows-suspend-force

Usage:

flows-suspend-force

Description: Suspends new flow executions and attempts to stop running flows. Use –force to skip confirmation.

Role: Super Admin

Confirmation: yes

Allow parallel: no

flows-resume

Usage:

flows-resume

Description: Resumes flow execution. Scheduler and manual runs are enabled.

Role: Super Admin

Confirmation: yes

Allow parallel: yes

etl-threads

Usage:

etl-threads

Description: Return ETL execution threads across all nodes, including parent and child threads, flowId, executionId, and CPU/RAM usage.

Role: Super Admin

Confirmation: no

Allow parallel: yes

Managing Connections

add-connection

Usage:

add-connection '<connection-json>'

Description: Create a new connection from a JSON payload.

Role: Editor

Confirmation: no

Allow parallel: yes

list-connections

Usage:

list-connections [scope=all]

Description: List connections. Use scope=all to list connections across all tenants, if permitted. Default scope returns connections accessible to the current tenant.

Role: Editor

Confirmation: no

Allow parallel: yes

get-connection

Usage:

get-connection <id>

Description: Get connection by id.

Role: Editor

Confirmation: no

Allow parallel: yes

edit-connection

Usage:

edit-connection <id> '<connection-json>'

Description: Update an existing connection using a JSON payload.

Role: Editor

Confirmation: yes

Allow parallel: yes

delete-connection

Usage:

delete-connection <id>

Description: Delete a connection by id.

Role: Editor

Confirmation: yes

Allow parallel: yes

test-connection

Usage:

test-connection <id> [agent=<agent-id>]
  [action=<agent-action-id>]

Description: Test a connection by id. You can optionally provide agent and agent action ids.

Role: Editor

Confirmation: no

Allow parallel: yes

build-default-connection

Usage:

build-default-connection <connection-type>

Description: Build a new connection object using descriptor defaults for the given connection type.

Role: Editor

Confirmation: no

Allow parallel: yes

connection-history

Usage:

connection-history <connection-id>

Description: Get change history for a connection.

Role: Editor

Confirmation: no

Allow parallel: yes

connection-history-diff

Usage:

connection-history-diff <connection-id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two history versions of a connection. Use 'current' as from or 'last' as to when needed.

Role: Editor

Confirmation: no

Allow parallel: yes

find-connection-usage

Usage:

find-connection-usage <connection-id>

Description: List flows that use the specified connection.

Role: Editor

Confirmation: no

Allow parallel: yes

Managing Formats

add-format

Usage:

add-format '<format-json>'

Description: Create a new format from a JSON payload.

Role: Editor

Confirmation: no

Allow parallel: yes

list-formats

Usage:

list-formats [scope=all]

Description: List connections. Use scope=all to list formats across all tenants, if permitted. Default scope returns formats accessible to the current tenant.

Role: Editor

Confirmation: no

Allow parallel: yes

get-format

Usage:

get-format <id>

Description: Get format by id.

Role: Editor

Confirmation: no

Allow parallel: yes

edit-format

Usage:

edit-format <id> '<format-json>'

Description: Update an existing format using a JSON payload.

Role: Editor

Confirmation: yes

Allow parallel: yes

delete-format

Usage:

delete-format <id>

Description: Delete a format by id.

Role: Editor

Confirmation: yes

Allow parallel: yes

build-default-format

Usage:

build-default-format <format-type>

Description: Build a new format using descriptor defaults for the given format type.

Role: Editor

Confirmation: no

Allow parallel: yes

format-history

Usage:

format-history <id>

Description: Get change history for a format.

Role: Editor

Confirmation: no

Allow parallel: yes

format-history-diff

Usage:

format-history-diff <id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two history versions of a format.

Role: Editor

Confirmation: no

Allow parallel: yes

find-format-usage

Usage:

find-format-usage <format-id>

Description: List flows that use the specified format.

Role: Editor

Confirmation: no

Allow parallel: yes

Managing Schedules

add-schedule

Usage:

add-schedule '<schedule-json>'

Description: Create a new schedule from a JSON payload.

Role: Administrator

Confirmation: yes

Allow parallel: yes

list-schedules

Usage:

list-schedules [scope=all]

Description: List schedules. Use scope=all to list schedules across all tenants, if permitted. Default scope returns schedules accessible to the current tenant.

Role: Administrator

Confirmation: no

Allow parallel: yes

get-schedule

Usage:

get-schedule <id>

Description: Get schedule by id.

Role: Administrator

Confirmation: no

Allow parallel: yes

edit-schedule

Usage:

edit-schedule <id> '<schedule-json>'

Description: Update an existing schedule using a JSON payload.

Role: Administrator

Confirmation: yes

Allow parallel: yes

delete-schedule

Usage:

delete-schedule <id>

Description: Delete a schedule by id.

Role: Administrator

Confirmation: yes

Allow parallel: yes

enable-schedule

Usage:

enable-schedule <schedule-id>

Description: Enable a schedule by id.

Role: Administrator

Confirmation: yes

Allow parallel: yes

disable-schedule

Usage:

disable-schedule <schedule-id>

Description: Disable a schedule by id.

Role: Administrator

Confirmation: yes

Allow parallel: yes

is-schedule-enabled

Usage:

is-schedule-enabled <schedule-id>

Description: Check if a schedule is enabled.

Role: Administrator

Confirmation: no

Allow parallel: yes

find-flow-schedules

Usage:

find-flow-schedules <flow-id>

Description: List schedules associated with a specific flow.

Role: Administrator

Confirmation: no

Allow parallel: yes

schedule-history

Usage:

schedule-history <schedule-id>

Description: Get change history for a schedule.

Role: Administrator

Confirmation: no

Allow parallel: yes

schedule-history-diff

Usage:

schedule-history-diff <schedule-id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two history versions of a schedule. Use ‘current' as from or ‘last' as to when needed.

Role: Administrator

Confirmation: no

Allow parallel: yes

Managing Macros

add-macro

Usage:

add-macro '<json>'

Description: Add a new macro.

Role: Editor

Confirmation: no

Allow parallel: yes

list-macros

Usage:

list-macros

Description: List all macros for the current tenant.

Role: Editor

Confirmation: no

Allow parallel: yes

get-macro

Usage:

get-macro <id>

Description: Get a macro by its ID.

Role: Editor

Confirmation: no

Allow parallel: yes

edit-macro

Usage:

edit-macro <id> '<json>'

Description: Edit an existing macro.

Role: Editor

Confirmation: yes

Allow parallel: yes

delete-macro

Usage:

delete-macro <id>

Description: Delete a macro by ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

macro-history

Usage:

macro-history <id>

Description: Get history records for a macro.

Role: Editor

Confirmation: no

Allow parallel: yes

macro-history-diff

Usage:

macro-history-diff <id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two macro history versions.

Role: Editor

Confirmation: no

Allow parallel: yes

Managing Agents

add-agent

Usage:

add-agent ‘<agentJson>'

Description: Creates a new agent from the provided JSON definition.

Role: Administrator

Confirmation: no

Allow parallel: yes

list-agents

Usage:

list-agents [scope=all] [extended=false|true]

Description: Lists Integration Agents installed for the current tenant. Use scope=all to list agents across all tenants (requires Tenant Admin). Use extended=true to include full agent details.

Role: Administrator

Confirmation: no

Allow parallel: yes

get-agent

Usage:

get-agent <agentId> [extended=false|true]

Description: Returns details for a specific Integration Agent by id. Use extended=true to include full configuration, including properties, ping payload, and flows.

Role: Administrator

Confirmation: no

Allow parallel: yes

edit-agent

Usage:

edit-agent <agentId> ‘<agentJson>'

Description: Updates an existing agent using the provided JSON definition. Requires confirmation.

Role: Administrator

Confirmation: yes

Allow parallel: yes

delete-agent

Usage:

delete-agent <agentId>

Description: Deletes an agent by ID. Requires confirmation.

Role: Administrator

Confirmation: yes

Allow parallel: yes

add-agent-action

Usage:

add-agent-action <agentId>
  ‘<agentActionJson>'

Description: Adds an action to the specified agent and returns the action receipt.

Role: Administrator

Confirmation: yes

Allow parallel: yes

start-agent

Usage:

start-agent <agentId> [verify=true|false]

Description

Sends a request to the updater service to start the agent. If verify=true (default), the command checks that the agent is currently stopped and that the updater service is available. Returns an action receipt with the action ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

stop-agent

Usage:

stop-agent <agentId> [verify=true|false]

Description

Sends a stop request to the agent. If verify=true (default), the command checks that the agent is currently running. Returns an action receipt with the action ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

restart-agent

Usage:

restart-agent <agentId> [verify=true|false]

Description

Sends a restart request to the updater service for the specified agent. The agent is stopped and then started by the updater. If verify=true (default), the command checks that the updater service is available. Returns an action receipt with the action ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

update-agent

Usage:

update-agent <agentId> [version=<version>] [verify=true|false]

Description

Requests the updater service to update the agent to a specific version.

  • If version is not provided, the agent is updated to the latest compatible version.

  • If version is provided, it must exist in the list of available agent releases or the command fails.

  • If the agent is already on the same or a newer version than requested, the command returns status "No update required" without sending an update action.

  • If verify=true (default), the command checks that the updater service is available.

Returns an action receipt with the action ID when an update is queued, or a JSON status when no update is required.

Role: Administrator

Confirmation: yes

Allow parallel: yes

enable-agent

Usage:

enable-agent <agentId>

Description

Enables the agent in the server configuration. The agent picks up the updated configuration on the next ping. Returns a JSON response that indicates whether the enabled flag was changed.

Role: Administrator

Confirmation: yes

Allow parallel: yes

disable-agent

Usage:

disable-agent <agentId>

Description

Disables the agent in the server configuration. The agent picks up the updated configuration on the next ping. Returns a JSON response that indicates whether the enabled flag was changed.

Role: Administrator

Confirmation: yes

Allow parallel: yes

set-agent-max-ram

Usage:

set-agent-max-ram <agentId> <maxRamMb> [verify=true|false]

Description

Requests the updater service to change the agent JVM maximum heap size (Xmx) to the specified value in megabytes.

If verify=true (default), the command checks that the updater service is available.

The new setting is applied by the updater and takes effect when the agent is restarted by the updater or via a restart/start action.

Returns an action receipt with the action ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

run-flow-on-agent

Usage:

run-flow-on-agent <agentId> <flowId> [description=<text>] [verify=true|false]

Description

Queues an action to run the specified flow on the agent.

  • Validates that the flow is assigned to the agent.

  • If description is not empty starts flow with a given id and description.
  • If verify=true (default), the command checks that the agent is currently running.

Returns an action receipt with the action ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

stop-flow-on-agent

Usage:

stop-flow-on-agent <agentId> <flowId> [verify=true|false]

Description

Queues an action to stop the specified flow on the agent.

  • Validates that the flow is assigned to the agent.

  • If description is not empty stops flow with a given id and description.

  • If verify=true (default), the command checks that the agent is currently running.

Returns an action receipt with the action ID.

Role: Administrator

Confirmation: yes

Allow parallel: yes

cancel-agent-action

Usage:

cancel-agent-action <agentId>
  <actionId>

Description: Cancels the specified agent action (actionId) for the specified agent (agentId) if it is still queued.

Role: Administrator

Confirmation: yes

Allow parallel: yes

get-agent-status

Usage:

get-agent-status <agentId>

Description: Returns status and metrics for the given agent.

Role: Administrator

Confirmation: no

Allow parallel: yes

agent-history

Usage:

agent-history <agentId>

Description: Returns the change history for the given agent.

Role: Administrator

Confirmation: no

Allow parallel: yes

agent-history-diff

Usage:

agent-history-diff <agentId>
  from=<uuid|current> to=<uuid|last>

Description: Returns a diff between two versions of the agent history.

Role: Administrator

Confirmation: no

Allow parallel: yes

Managing Webhooks

add-webhook

Usage:

add-webhook '<webhook-json>'

Description: Create a new webhook from a JSON payload.

Role: Administrator

Confirmation: yes

Allow parallel: yes

list-webhooks

Usage:

list-webhooks [scope=all]

Description: List webhooks. Use scope=all to list webhooks across all tenants, if permitted.

Role: Administrator

Confirmation: no

Allow parallel: yes

get-webhook

Usage:

get-webhook <id>

Description: Get webhook by id.

Role: Administrator

Confirmation: no

Allow parallel: yes

edit-webhook

Usage:

edit-webhook <id> '<webhook-json>'

Description: Update an existing webhook using a JSON payload.

Role: Administrator

Confirmation: yes

Allow parallel: yes

delete-webhook

Usage:

delete-webhook <id>

Description: Delete a webhook by id.

Role: Administrator

Confirmation: yes

Allow parallel: yes

get-webhook-events

Usage:

get-webhook-events <webhook-id>

Description: Get latest events for a webhook.

Role: Administrator

Confirmation: no

Allow parallel: yes

get-webhook-event

Usage:

get-webhook-event <webhook-id>
  <event-id>

Description: Get a specific webhook event by ID.

Role: Administrator

Confirmation: no

Allow parallel: yes

Managing Tenants

add-tenant

Usage:

add-tenant ‘<tenantJson>'

Description: Creates a new tenant from the provided JSON definition.

Role: Super Admin

Confirmation: no

Allow parallel: yes

list-tenants

Usage:

list-tenants

Description: List all tenants

Role: Super Admin

Confirmation: no

Allow parallel: yes

get-tenant

Usage:

get-tenant <id>

Description: Retrieve a tenant by ID

Role: Super Admin

Confirmation: no

Allow parallel: yes

edit-tenant

Usage:

edit-tenant <tenantId>
  ‘<tenantJson>'

Description: Updates an existing tenant using the provided JSON definition. Requires confirmation.

Role: Super Admin

Confirmation: yes

Allow parallel: yes

Managing Users

add-user

Usage:

add-user ‘<userJson>'

Description: Creates a new user from the provided JSON definition.

Role: Administrator

Confirmation: no

Allow parallel: yes

list-users

Usage:

list-users

Description: List all users visible to this administrator

Role: Administrator

Confirmation: no

Allow parallel: yes

get-user

Usage:

get-user <id>

Description: Retrieve a user by ID

Role: Administrator

Confirmation: no

Allow parallel: yes

edit-user

Usage:

edit-user <userId> ‘<userJson>'

Description: Updates an existing user using the provided JSON definition. Requires confirmation.

Role: Administrator

Confirmation: yes

Allow parallel: yes

Messages

list-messages

Usage:

list-messages

Description: List up to 1000 recent messages for the current tenant.

Role: Administrator

Confirmation: no

Allow parallel: yes

list-messages-filtered

Usage: 

list-messages-filtered [sender=<name>] [size=<n>] 
[sizeType=<Byte|KB|MB>] [comparator=< <|=|> >] [
fromDate=<epoch>] [toDate=<epoch>] [status=<s>] [
format=<fmt>] [message=<substring>] [scheduleName=<name>]

Description: List messages using a filter (sender, size, dates, status, format, etc.).

Role: Administrator

Confirmation: no

Allow parallel: yes

get-message

Usage:

get-message <messageId>

Description: Get and pretty-print the message body for the specified message ID.

Role: Administrator

Confirmation: no

Allow parallel: yes

Managing Tags

list-tags

Usage:

list-tags [global=false|true] [include=types] [exclude=types]

Description: List all tags for the current tenant or globally. Supports optional filters

Role: Editor

Confirmation: no

Allow parallel: yes

update-tags

Usage:

update-tags '<json>'

Description: Renames or deletes tags for the current account or tenant. JSON argument required.

Role: Administrator

Confirmation: yes

Allow parallel: yes

Example: 

update-tags '{"trim":true, "caseSensitive":true, 
"rename":[{"oldTag":"bigquery","newTag":"google bq"}], 
"delete":[{"tag":"bulk_merge"}, {"tag":"bulk_ merge"}]}'

update-all-tags

Usage:

update-all-tags '<json>'

Description: Renames or deletes tags across tenants. Super admin only. JSON argument required.

Role: Super Admin

Confirmation: yes

Allow parallel: yes

update-tenant-tags

Usage:

update-tenant-tags <tenantId> '<json>'

Description: Renames or deletes tags for the given tenant. tenantId and JSON argument required.

Role: Administrator

Confirmation: yes

Allow parallel: yes

Data Access

data-get-raw

Usage: 

data-get-raw connectionId=<id> object=<name> formatId=<id> 
[agent=<agentId>] [action=<agentActionId>]

Description: Retrieve raw, unprocessed data from a connection object in its native format.

Role: Editor

Confirmation: no

Allow parallel: yes

data-run-sql

Usage: 

data-run-sql connectionId=<id> [object=<name>] [formatId=<id>] 
[sql=\"<statement>\"] [script=true|false] [agent=<agentId>] [action=<agentActionId>]

Description: Execute SQL or retrieve data from a connection object. Supports SQL databases, files, APIs, and other data sources. SQL must be eclised in double quotes.

Role: Editor

Confirmation: no

Allow parallel: yes

get-sql-history

Usage:

get-sql-history <connectionId>

Description: Get executed SQL history for the specified connection.

Role: Editor

Confirmation: no

Allow parallel: yes

Object History and Diffs

connection-history

Usage:

connection-history <connection-id>

Description: Get change history for a connection.

Role: Editor

Confirmation: no

Allow parallel: yes

connection-history-diff

Usage:

connection-history-diff <connection-id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two history versions of a connection. Use “current” as from or “last” as to when needed.

Role: Editor

Confirmation: no

Allow parallel: yes

format-history

Usage:

format-history <id>

Description: Get change history for a format.

Role: Editor

Confirmation: no

Allow parallel: yes

format-history-diff

Usage:

format-history-diff <id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two history versions of a format.

Role: Editor

Confirmation: no

Allow parallel: yes

macro-history

Usage:

macro-history <id>

Description: Get history records for a macro.

Role: Editor

Confirmation: no

Allow parallel: yes

macro-history-diff

Usage:

macro-history-diff <id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two macro history versions.

Role: Editor

Confirmation: no

Allow parallel: yes

agent-history

Usage:

agent-history <agentId>

Description: Returns the change history for the given agent.

Role: Administrator

Confirmation: no

Allow parallel: yes

agent-history-diff

Usage:

agent-history-diff <agentId>
  from=<uuid|current> to=<uuid|last>

Description: Returns a diff between two versions of the agent history.

Role: Administrator

Confirmation: no

Allow parallel: yes

schedule-history

Usage:

schedule-history <schedule-id>

Description: Get change history for a schedule.

Role: Administrator

Confirmation: no

Allow parallel: yes

schedule-history-diff

Usage:

schedule-history-diff <schedule-id>
  <from-uuid|current> <to-uuid|last>

Description: Get diff between two history versions of a schedule.

Role: Administrator

Confirmation: no

Allow parallel: yes

flow-history

Usage:

flow-history <flowId>

Description: Returns the change history for the given flow.

Role: Editor

Confirmation: no

Allow parallel: yes

flow-history-diff

Usage:

flow-history-diff <flowId>
  from=<uuid|current> to=<uuid|last>

Description: Returns a diff between two versions of the flow history.

Role: Editor

Confirmation: no

Allow parallel: yes

System Metrics and Monitoring

metrics

Usage:

metrics [tenantId=<id>]

Description: Return system metrics for the current tenant, or for a specific tenant if tenantId is provided.

Role: Administrator

Confirmation: no

Allow parallel: yes

metrics-aggregated

Usage:

metrics-aggregated tenants=<id1,id2,…|all>

Description: Return aggregated metrics across multiple tenants. When tenants=all is supplied, the command returns results for all active tenants.

Role: Super Admin

Confirmation: no

Allow parallel: yes

etl-threads

Usage:

etl-threads

Description: Return ETL execution threads across all nodes, including parent and child threads, associated flowId, executionId, and approximate CPU and RAM usage.

Role: Super Admin

Confirmation: no

Allow parallel: yes

health

Usage: health

Description: Returns system health.

Role: none

Confirmation: no

Allow parallel: yes

Administrative Runtime Controls

flows-suspend

Usage:

flows-suspend

Description: Suspends new flow executions. Scheduler and manual executions are blocked. Running flows continue.

Role: Super Admin

Confirmation: yes

Allow parallel: no

flows-suspend-force

Usage:

flows-suspend-force

Description: Suspends new flow executions and attempts to stop running flows. Use –force to skip confirmation.

Role: Super Admin

Confirmation: yes

Allow parallel: no

flows-resume

Usage:

flows-resume

Description: Resumes flow execution. Scheduler and manual runs are enabled.

Role: Super Admin

Confirmation: yes

Allow parallel: yes

stop-flow

Usage:

stop-flow <id>

Description: Attempts to stop a running flow with the given ID. Use –force to skip confirmation.

Role: Operator

Confirmation: yes

Allow parallel: yes

list-app-releases

Usage:

list-app-releases [limit]

Description

Returns a list of available Etlworks application releases. Results are sorted from newest to oldest. Limit is an optional positional parameter which defines maximum number of releases to return. Default is 10.

Role: all

Confirmation: no

Allow parallel: yes

list-agent-releases

Usage:

list-agent-releases [limit]

Description

Returns a list of available Integration Agent releases, sorted from newest to oldest. Includes version, commit, compatibility information, and release notes. Limit is an optional positional parameter which defines maximum number of releases to return. Default is 10.

Role: all

Confirmation: no

Allow parallel: yes

version

Usage:

version [extended]

Description

Shows the current Etlworks application version and ETL engine version. Use extended to include release notes, license information, and system environment details.

Role: all

Confirmation: no

Allow parallel: yes

update

Usage:

update

Description

Checks whether the currently installed Etlworks version is up to date. If a newer version is available, the command returns detailed upgrade instructions based on the deployment type (single-node or multi-node).

This command does not perform the upgrade; it only provides guidance.

The output includes:

  • currentVersion – the version currently installed

  • latestVersion – the newest version available

  • needsUpdate – whether an upgrade is required

  • multiNode – whether the deployment consists of more than one node

  • instructions – upgrade steps appropriate for Linux or Windows, including multi-node steps

  • documentation – link to the official support article for upgrading

Role: Super Admin

Confirmation: no

Allow parallel: yes

Search

search

Usage:

search '<keywords>'

Description: Search objects in the current tenant using keywords.

Role: all

Confirmation: no

Allow parallel: yes

flow-search

Usage:

flow-search <flowId> '<search string>'

Description: Search a flow hierarchy (including nested flows) for a given string. Returns a JSON response with matching flow IDs and match count per flow.

Role: all

Confirmation: no

Allow parallel: yes

Utility Commands

print

Usage:

print <template>

Description: Outputs the template after all variables have been substituted.

Role: all

Confirmation: no

Allow parallel: yes

help

Usage:

help [full=true] [asJson=true]

Description: Show help for all available commands.

Role: all

Confirmation: no

Allow parallel: yes

Related articles