Flows Page

The Flows page lists every automated response flow your tenant can use. From here you create flows, open them in the editor, switch them on and off, and start them by hand.

Open it from SOAR > Flows.

Page layout

The Flows page with the Total flows, Active, Executions (24h) and Failed (24h) tiles, the search box, the All, Active, Inactive, System and Custom tabs, the New flow button and the flow list with platform, conditions, commands, last run, the Active switch, the Trigger flow button and View

At the top you find a search box (Search flows…), a Refresh button and the New flow button.

Four number tiles summarise your flows:

TileWhat it counts
Total flowsAll flows you can see, shipped and your own.
ActiveFlows that are switched on for your tenant.
Executions (24h)Rows in Execution history from the last 24 hours: flow steps and Interactive Console commands.
Failed (24h)Those rows whose status is Failed.

Tabs filter the list: All, Active, Inactive, System (flows that ship with the product) and Custom (flows your tenant created).

Columns

ColumnWhat it shows
FlowThe flow name, with its description below it.
PlatformThe platform set on the flow's shell steps.
ConditionsThe trigger conditions.
CommandsHow many steps the flow has.
ActiveThe switch that turns the flow on or off for your tenant.
Last runWhen a step of the flow last ran, or "never". If some steps failed, it shows how many ("N failed runs"). Both are counted over the 500 most recent rows of Execution history.
ActionsTrigger flow starts the flow by hand. View (or a click anywhere on the row) opens the editor. Shipped flows show a lock icon next to View.

On a multi-tenant installation the instance operator also sees Apply to all tenants (see below).

Switch a flow on or off

Use the Active switch in the flow's row. The switch applies to your tenant only.

A flow you create from scratch is saved switched on, and it starts reacting to alerts as soon as you save it. The editor has no on/off switch. If you want to build a flow without it running, start from a copy of an existing flow (copies are saved switched off), or switch the flow off in this list right after the first save.

Every alert that matches a switched-on flow starts a new run. UTMStack does not group or limit runs.

Shipped flows are read-only

Shipped flows (lock icon in the list, listed on the System tab, and marked System in the editor) cannot be edited or deleted. If you try, the server answers "system alert response rule is read-only". To change one, copy it (see below) and edit the copy. See Shipped Flows for the full list.

Create a flow

  1. 1

    Click New flow

    A chooser opens with two options:

    • From scratch: "An empty definition you fill in yourself."

    • From an existing one: "Everything is copied except the identifier and the name."

    The New flow dialog with the two choices From scratch and From an existing one
  2. 2

    Start from scratch

    The New flow dialog offers two modes:

    • Create manually: enter Flow name, Description and Max depth (default 50), then click Continue. The editor opens with an empty canvas.

    • Using AI: describe the flow in What should this flow do? and click Create with AI. The SOC-AI assistant drafts the flow for you. This mode is locked, with the hint "Enable SOC-AI and configure it to use this.", until an AI provider is set up. See SOC-AI Assistant.

  3. 3

    Or start from an existing flow

    Pick the flow to copy. Its conditions, steps, shells and platforms are copied. Give the copy a new name. The copy is saved switched off.

  4. 4

    Build and save

    Set the trigger conditions, add steps and wire them, then click Save. See Building a Flow.

Flow names and file names

Each flow is stored as a file whose name is made from the flow name: lower case, with every character that is not a letter or a digit turned into -, plus .yaml. For example, "Block IP on repeated failures" becomes block-ip-on-repeated-failures.yaml.

  • Two names that make the same file name collide. The server answers "rule name already in use".

  • Renaming a flow later keeps its original file name.

  • A name can be up to 150 characters, a description up to 512.

Start a flow by hand

Trigger flow runs a flow once against an alert you choose. Use it to test a flow before you switch it on.

  1. 1

    Click Trigger flow in the flow's row

    The dialog Trigger <flow name> opens.

  2. 2

    Choose the alert

    • Stored alert: search your alerts and pick one.

    • Raw alert JSON: paste an alert as JSON.

  3. 3

    Choose the agent

    Agent defaults to Same agent as the alert. Pick another agent to run the shell steps somewhere else, for example on a test machine.

  4. 4

    Click Trigger flow

    The run appears in SOAR > Execution history.

  • The flow's own trigger conditions are ignored for a manual run.

  • A manual run works even when the flow is switched off.

  • Starting a flow by hand needs the soar.execute permission, which only the Administrator role has.

  • A shell step that names its own host always runs there, even if you pick another agent in this dialog. The agent you pick reaches the shell steps that start the flow and the steps after them; when the flow starts with a Conditional or HTTP call step, its shell steps run on the alert's host. See Running Steps on Another Host.

Apply to all tenants

On a multi-tenant installation the instance operator can create, update, delete, or switch on and off a flow in many tenants at once with Apply to all tenants. See Apply to All Tenants.

  • You choose the target tenants before the action runs. The platform tenant itself is excluded.

  • Each tenant is handled on its own. Failures are listed after the run ("Per-tenant failures are reported after the run and are not rolled back.").

  • Building a Flow

  • Shipped Flows

  • Execution History and Run Statuses

  • Troubleshooting Flows