Skip to content

IOA Exclusions

The IOA Exclusions service collection provides operations for managing Indicator of Attack exclusion rules. Create, update, delete, and query standard IOA exclusions, as well as manage Self Service IOA Exclusions including aggregates, reports, matched rules, and default rule retrieval.

LanguageLast Update
Pythonv1.6.5
PowerShellv2.2.9
Gov0.22.0
TypeScriptv0.6.0
Rustv0.7.1
Rubyv1.4.0

This service collection has code examples posted to the repository.



OperationDescription
createIOAExclusionsV1
create_exclusions
Create the IOA exclusions
deleteIOAExclusionsV1
delete_exclusions
Delete the IOA exclusions by id
getIOAExclusionsV1
get_exclusions
Get a set of IOA Exclusions by specifying their IDs
queryIOAExclusionsV1
query_exclusions
Search for IOA exclusions.
ss-ioa-exclusions.aggregates.v2
get_ss_exclusion_aggregates
Get Self Service IOA Exclusion aggregates as specified via json in the request body.
ss-ioa-exclusions.create.v2
create_ss_exclusions
Create new Self Service IOA Exclusions.
ss-ioa-exclusions.delete.v2
delete_ss_exclusions
Delete the Self Service IOA Exclusions rule by id.
ss-ioa-exclusions.get-reports.v2
get_ss_exclusion_reports_v2
Create a report of Self Service IOA Exclusions scoped by the given filters
ss-ioa-exclusions.get.v2
get_ss_exclusion_rules_v2
Get the Self Service IOA Exclusions rules by id.
ss-ioa-exclusions.matched-rule.v2
get_ss_exclusion_matched_rules
Get Self Service IOA Exclusions rules for matched IFN/CLI for child, parent and grandparent
ss-ioa-exclusions.new-rules.v2
get_default_ss_exclusions
Get defaults for Self Service IOA Exclusions based on provided IFN/CLI for child, parent and grandparent.
ss-ioa-exclusions.search.v2
query_ss_exclusions
Search for Self Service IOA Exclusions.
ss-ioa-exclusions.update.v2
update_ss_exclusions
Update the Self Service IOA Exclusions rule by id.
updateIOAExclusionsV1
update_exclusions
Update the IOA exclusions

Create the IOA exclusions

Method POST
Route /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: WRITE
PEP 8 create_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
cl_regex body · string
Command line regex value for the exclusion.
comment body · string
Comment describing why the exclusion is entered.
description body · string
Description of the exclusion.
detection_json body · string
Detection JSON payload for the exclusion.
groups body · array
Group IDs to exclude.
ifn_regex body · string
Image file name regex value for the exclusion.
name body · string
Name of the exclusion.
pattern_id body · string
Pattern ID associated with the exclusion.
pattern_name body · string
Pattern name associated with the exclusion.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.create_exclusions(cl_regex="string",
comment="string",
description="string",
detection_json="string",
groups=id_list,
ifn_regex="string",
name="string",
pattern_id="string",
pattern_name="string")
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Delete the IOA exclusions by id

Method DELETE
Route /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: WRITE
PEP 8 delete_exclusions
ids query · string or list of strings
The ids of the exclusions to delete
comment query · string
Explains why this exclusions was deleted
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_exclusions(comment="string", ids=id_list)
print(response)
[
"string"
]


Get a set of IOA Exclusions by specifying their IDs

Method GET
Route /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: READ
PEP 8 get_exclusions
ids query · string or list of strings
The ids of the exclusions to retrieve
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_exclusions(ids=id_list)
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Search for IOA exclusions.

Method GET
Route /policy/queries/ioa-exclusions/v1
Scope IOA Exclusions: READ
PEP 8 query_exclusions
filter query · string
The filter expression that should be used to limit the results. FQL syntax. Available filters:
Available values (8)
namepattern_idpattern_name
applied_globallycreated_oncreated_by
last_modifiedmodified_by
ifn_regex query · string
The ifn_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
cl_regex query · string
The cl_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
offset query · integer
The offset to start retrieving records from
limit query · integer
The maximum records to return. [1-500]
sort query · string
The property to sort by. FQL syntax. (e.g. last_behavior.asc) Available sort fields:
Available values (16)
applied_globally.ascapplied_globally.desccreated_by.asc
created_by.desccreated_on.asccreated_on.desc
last_modified.asclast_modified.descmodified_by.asc
modified_by.descname.ascname.desc
pattern_id.ascpattern_id.descpattern_name.asc
pattern_name.desc
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_exclusions(cl_regex="string",
filter="string",
ifn_regex="string",
limit=integer,
offset=integer,
sort="string")
print(response)
[
"string"
]


Get Self Service IOA Exclusion aggregates as specified via json in the request body.

Method POST
Route /exclusions/aggregates/ss-ioa-exclusions/GET/v2
Scope IOA Exclusions: WRITE
PEP 8 get_ss_exclusion_aggregates
body body · dictionary
Full body payload as JSON formatted dictionary.
date_ranges body · array
Date range timeframe.
exclude body · string
Fields to exclude from results.
extended_bounds body · object
Extended bounds for histogram aggregations.
field body · string
Field to aggregate on.
filter body · string
filters_spec body · object
Additional filter specifications.
from body · integer
Starting index of overall result set.
include body · string
Fields to include in results.
interval body · string
max_doc_count body · integer
Maximum number of documents per bucket.
min_doc_count body · integer
Minimum number of documents per bucket.
missing body · string
Value to use for documents missing the field.
name body · string
Name of the aggregation.
percents body · array
Percentile values to calculate.
q body · string
Full text search query.
ranges body · array
Range boundaries for range aggregations.
size body · integer
Maximum number of records to return.
sort body · string
The field to sort on.
sub_aggregates body · array
Nested aggregation definitions.
time_zone body · string
Time zone for date histogram aggregations.
type body · string
Type of aggregation to perform.
ifn_regex query · string
The ifn_regex expression to filter exclusion aggregations by, used alongside filter expressions provided in the request body.
cl_regex query · string
The cl_regex expression to filter exclusion aggregations by, used alongside filter expressions provided in the request body.
parent_ifn_regex query · string
The parent_ifn_regex expression to filter exclusion aggregations by, used alongside filter expressions provided in the request body.
parent_cl_regex query · string
The parent_cl_regex expression to filter exclusion aggregations by, used alongside filter expressions provided in the request body.
grandparent_ifn_regex query · string
The grandparent_ifn_regex expression to filter exclusion aggregations by, used alongside filter expressions provided in the request body.
grandparent_cl_regex query · string
The grandparent_cl_regex expression to filter exclusion aggregations by, used alongside filter expressions provided in the request body.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
extended_bounds = {
"max": "string",
"min": "string"
}
filters_spec = {
"filters": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"other_bucket": True,
"other_bucket_key": "string"
}
ranges = [
{
"From": 0,
"To": 0
}
]
response = falcon.get_ss_exclusion_aggregates(ifn_regex="string",
cl_regex="string",
parent_ifn_regex="string",
parent_cl_regex="string",
grandparent_ifn_regex="string",
grandparent_cl_regex="string",
date_ranges=date_ranges,
exclude="string",
extended_bounds=extended_bounds,
field="string",
filters_spec=filters_spec,
from=integer,
include="string",
max_doc_count=integer,
min_doc_count=integer,
missing="string",
name="string",
percents=[integer],
q="string",
ranges=ranges,
size=integer,
sort="string",
sub_aggregates=["string"],
time_zone="string",
type="string")
print(response)
[
{
"buckets": [],
"doc_count_error_upper_bound": 0,
"hits": {},
"name": "string",
"sum_other_doc_count": 0
}
]


Create new Self Service IOA Exclusions.

Method POST
Route /exclusions/entities/ss-ioa-exclusions/v2
Scope IOA Exclusions: WRITE
PEP 8 create_ss_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
exclusions body · array
List of exclusion definitions to create.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
exclusions = [
{
"cl_regex": "string",
"comment": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [
"string"
],
"ifn_regex": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]
response = falcon.create_ss_exclusions(exclusions=exclusions)
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"comment": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Delete the Self Service IOA Exclusions rule by id.

Method DELETE
Route /exclusions/entities/ss-ioa-exclusions/v2
Scope IOA Exclusions: WRITE
PEP 8 delete_ss_exclusions
ids query · string or list of strings
The ids of the exclusions to delete
comment query · string
The comment why these ss ioa exclusions were deleted
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_ss_exclusions(ids=id_list, comment="string")
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"comment": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Create a report of Self Service IOA Exclusions scoped by the given filters

Method POST
Route /exclusions/entities/ss-ioa-exclusions/reports/v2
Scope IOA Exclusions: WRITE
PEP 8 get_ss_exclusion_reports_v2
body body · dictionary
Full body payload as JSON formatted dictionary.
report_format body · string
Format of the report to generate.
search body · object
Search criteria including filter and sort options.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
search = {
"filter": "string",
"sort": "string"
}
response = falcon.get_ss_exclusion_reports_v2(report_format="string",
search=search)
print(response)
{
"errors": [
{
"code": 0,
"id": "string",
"message": "string"
}
],
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
},
"powered_by": "string",
"query_time": 0.0,
"trace_id": "string",
"writes": {
"resources_affected": 0
}
}
}


Get the Self Service IOA Exclusions rules by id.

Method GET
Route /exclusions/entities/ss-ioa-exclusions/v2
Scope IOA Exclusions: READ
PEP 8 get_ss_exclusion_rules_v2
ids query · string or list of strings
The ids of the exclusions to retrieve
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_ss_exclusion_rules_v2(ids=id_list)
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"comment": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Get Self Service IOA Exclusions rules for matched IFN/CLI for child, parent and grandparent

Method POST
Route /exclusions/entities/ss-ioa-matched-rules/v2
Scope IOA Exclusions: WRITE
PEP 8 get_ss_exclusion_matched_rules
body body · dictionary
Full body payload as JSON formatted dictionary.
aid body · string
Agent ID to match exclusions against.
command_line body · string
Command line of the child process.
grandparent_command_line body · string
Command line of the grandparent process.
grandparent_image_file_name body · string
Image file name of the grandparent process.
image_file_name body · string
Image file name of the child process.
parent_command_line body · string
Command line of the parent process.
parent_image_file_name body · string
Image file name of the parent process.
pattern_ids body · array
Pattern IDs to match exclusions against.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_ss_exclusion_matched_rules(aid="string",
command_line="string",
grandparent_command_line="string",
grandparent_image_file_name="string",
image_file_name="string",
parent_command_line="string",
parent_image_file_name="string",
pattern_ids=id_list)
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"comment": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Get defaults for Self Service IOA Exclusions based on provided IFN/CLI for child, parent and grandparent.

Method POST
Route /exclusions/entities/ss-ioa-new-rules/v2
Scope IOA Exclusions: WRITE
PEP 8 get_default_ss_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
aid body · string
Agent ID to get default exclusions for.
command_line body · string
Command line of the child process.
grandparent_command_line body · string
Command line of the grandparent process.
grandparent_image_file_name body · string
Image file name of the grandparent process.
image_file_name body · string
Image file name of the child process.
parent_command_line body · string
Command line of the parent process.
parent_image_file_name body · string
Image file name of the parent process.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_default_ss_exclusions(aid="string",
command_line="string",
grandparent_command_line="string",
grandparent_image_file_name="string",
image_file_name="string",
parent_command_line="string",
parent_image_file_name="string")
print(response)
{
"aid": "string",
"cl_regex": "string",
"command_line": "string",
"grandparent_cl_regex": "string",
"grandparent_command_line": "string",
"grandparent_ifn_regex": "string",
"grandparent_image_file_name": "string",
"host_groups": [
"string"
],
"ifn_regex": "string",
"image_file_name": "string",
"parent_cl_regex": "string",
"parent_command_line": "string",
"parent_ifn_regex": "string",
"parent_image_file_name": "string"
}


Search for Self Service IOA Exclusions.

Method GET
Route /exclusions/queries/ss-ioa-exclusions/v2
Scope IOA Exclusions: READ
PEP 8 query_ss_exclusions
filter query · string
The filter expression that should be used to limit the results.
ifn_regex query · string
The ifn_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
cl_regex query · string
The cl_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
parent_ifn_regex query · string
The parent_ifn_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
parent_cl_regex query · string
The parent_cl_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
grandparent_ifn_regex query · string
The grandparent_ifn_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
grandparent_cl_regex query · string
The grandparent_cl_regex expression to filter exclusions by, used alongside expressions specified in the filter query parameter.
offset query · integer
The offset to start retrieving records from
limit query · integer
The maximum records to return. [1-500]
sort query · string
The sort expression that should be used to sort the results.
Available values (12)
name.ascname.descpattern_id.asc
pattern_id.descpattern_name.ascpattern_name.desc
created_by.asccreated_by.desclast_modified.asc
last_modified.descmodified_by.ascmodified_by.desc
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_ss_exclusions(filter="string",
ifn_regex="string",
cl_regex="string",
parent_ifn_regex="string",
parent_cl_regex="string",
grandparent_ifn_regex="string",
grandparent_cl_regex="string",
offset=integer,
limit=integer,
sort="string")
print(response)
[
"string"
]


Update the Self Service IOA Exclusions rule by id.

Method PATCH
Route /exclusions/entities/ss-ioa-exclusions/v2
Scope IOA Exclusions: WRITE
PEP 8 update_ss_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
exclusions body · array
List of exclusion definitions to update.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
exclusions = [
{
"cl_regex": "string",
"comment": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [
"string"
],
"id": "string",
"ifn_regex": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]
response = falcon.update_ss_exclusions(exclusions=exclusions)
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"comment": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"grandparent_cl_regex": "string",
"grandparent_ifn_regex": "string",
"host_groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"parent_cl_regex": "string",
"parent_ifn_regex": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]


Update the IOA exclusions

Method PATCH
Route /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: WRITE
PEP 8 update_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
cl_regex body · string
Command line regex value for the exclusion.
comment body · string
Comment describing why the exclusion is updated.
description body · string
Description of the exclusion.
detection_json body · string
Detection JSON payload for the exclusion.
groups body · array
Group IDs to exclude.
id body · string
Identifier of the exclusion to update.
ifn_regex body · string
Image file name regex value for the exclusion.
name body · string
Name of the exclusion.
pattern_id body · string
Pattern ID associated with the exclusion.
pattern_name body · string
Pattern name associated with the exclusion.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.update_exclusions(cl_regex="string",
comment="string",
description="string",
detection_json="string",
groups=id_list,
id="string",
ifn_regex="string",
name="string",
pattern_id="string",
pattern_name="string")
print(response)
[
{
"applied_globally": false,
"cl_regex": "string",
"created_by": "string",
"created_on": "string",
"description": "string",
"detection_json": "string",
"groups": [],
"id": "string",
"ifn_regex": "string",
"last_modified": "string",
"modified_by": "string",
"name": "string",
"pattern_id": "string",
"pattern_name": "string"
}
]