Loop break

The loop.break step exits the innermost enclosing foreach or while loop immediately. Use it to stop iterating once a condition is met, for example when you want to process items until you find the first critical match and then move on.

Schema convention. In each schema table on this page, the Location column indicates where each parameter sits in the YAML:

top level: Alongside type and name, at the top of the step or trigger definition.
`with`: Inside the step's with: block.
`on`: Inside the trigger's on: block.

Parameters

The loop.break step takes no step-specific parameters; only the standard name and type fields required on every step.

Parameter	Location	Type	Required	Description
`name`	top level	string	Yes	Unique step identifier.
`type`	top level	string	Yes	Must be `loop.break`.

Example: Stop on first critical match

- name: find_critical
  type: foreach
  foreach: "${{ event.alerts }}"
  steps:
    - name: check_critical
      type: if
      condition: "foreach.item.kibana.alert.severity : critical"
      steps:
        - name: record_and_exit
          type: cases.addComment
          with:
            case_id: "{{ consts.triage_case_id }}"
            comment: "First critical alert found at position {{ foreach.index }}"
        - name: exit
          type: loop.break

The loop terminates as soon as the first critical alert is processed.

Flow control steps: Overview of all flow-control types.
Loop continue step: Skip to the next iteration instead of exiting.
Foreach step and While step: The loop types loop.break can exit from.