Skip to content

Get FalconIoaRule

bk-cs edited this page Oct 6, 2022 · 22 revisions

Get-FalconIoaRule

SYNOPSIS

Search for custom Indicator of Attack rules

DESCRIPTION

Requires 'Custom IOA Rules: Read'.

PARAMETERS

Name Type Min Max Allowed Pipeline PipelineByName Description
Id String[] X X Rule identifier
Filter String Falcon Query Language expression to limit results
Query String Perform a generic substring search across available fields
Sort String rules.created_by.asc
rules.created_by.desc
rules.created_on.asc
rules.created_on.desc
rules.current_version.action_label.asc
rules.current_version.action_label.desc
rules.current_version.description.asc
rules.current_version.description.desc
rules.current_version.modified_by.asc
rules.current_version.modified_by.desc
rules.current_version.modified_on.asc
rules.current_version.modified_on.desc
rules.current_version.name.asc
rules.current_version.name.desc
rules.current_version.pattern_severity.asc
rules.current_version.pattern_severity.desc
rules.enabled.asc
rules.enabled.desc
rules.ruletype_name.asc
rules.ruletype_name.desc
Property and direction to sort results
Limit Int32 1 500 Maximum number of results per request
Offset Int32 Position to begin retrieving results
Detailed Switch Retrieve detailed information
All Switch Repeat requests until all available results are retrieved
Total Switch Display total result count instead of results

SYNTAX

Get-FalconIoaRule [[-Filter] <String>] [[-Query] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] 
[<CommonParameters>]
Get-FalconIoaRule -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

USAGE

Find custom IOA rules

Get-FalconIoaRule [-Detailed]

Find a custom IOA rule identifier by name within a rule group

Get-FalconIoaRule -Filter "id:'<id>'+rules.name:'BugRule'" [-Detailed] [-All]

Generated 2022-10-06 using PSFalcon v2.2.3

Clone this wiki locally