Skip to content

Invoke FalconWorkflow

bk-cs edited this page Sep 3, 2024 · 1 revision

Invoke-FalconWorkflow

SYNOPSIS

Execute an on-demand Falcon Fusion workflow

DESCRIPTION

Requires 'Workflow: Write'.

PARAMETERS

Name Type Description Min Max Allowed Pipeline PipelineByName
Cid String[] Target CID. Child CIDs are supported in Flight Control environments.
Key String Optional UUID used to help de-duplicate executions
Depth Int32 Execution depth limit to help prevent execution loops from multiple workflow triggers 1 4
SourceEventUrl String Optional source URL for auditing
Json String Json string to define workflow trigger key/value pairs
Name String Workflow name X
Id String[] Workflow identifier X X

SYNTAX

Invoke-FalconWorkflow [[-Cid] <String[]>] [[-Key] <String>] [[-Depth] <Int32>] [[-SourceEventUrl] <String>] -Json <String> -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Invoke-FalconWorkflow [[-Cid] <String[]>] [[-Key] <String>] [[-Depth] <Int32>] [[-SourceEventUrl] <String>] -Json <String> -Name <String> [-WhatIf] [-Confirm] [<CommonParameters>]

REFERENCE

Endpoints

POST /workflows/entities/execute/v1

falconpy

WorkflowExecute

USAGE

2024-09-03: PSFalcon v2.2.7

Clone this wiki locally