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.1
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
getIOAExclusionsV1
get_exclusions
Get a set of IOA Exclusions by specifying their IDs.
createIOAExclusionsV1
create_exclusions
Create the IOA exclusions.
deleteIOAExclusionsV1
delete_exclusions
Delete the IOA exclusions by ID.
updateIOAExclusionsV1
update_exclusions
Update the IOA exclusions.
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_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_create_v2
create_ss_exclusions
Create new Self Service IOA Exclusions.
ss_ioa_exclusions_update_v2
update_ss_exclusions
Update the Self Service IOA Exclusions rule by id.
ss_ioa_exclusions_delete_v2
delete_ss_exclusions
Delete the Self Service IOA Exclusions rule 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.

Get a set of IOA Exclusions by specifying their IDs

GET /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: READ Consumes · Produces application/json
PEP 8 get_exclusions
NameTypeData typeDescription
idsquerystring or list of stringsThe IDs of the exclusions to retrieve.
parametersquerydictionaryFull query string parameters payload in JSON format.
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)

Create the IOA exclusions

POST /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 create_exclusions
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
cl_regexbodystringCommand line regular expression.
commentbodystringString comment describing why the exclusions was created.
descriptionbodystringExclusion description.
detection_jsonbodystringJSON formatted detection template.
groupsbodylist of stringsGroup ID(s) impacted by the exclusion.
ifn_regexbodystringIndicator file name regular expression.
namebodystringName of the exclusion.
pattern_idbodystringID of the pattern to use for the exclusion.
pattern_namebodystringName of the pattern to use for the exclusion.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.create_exclusions(cl_regex="string",
comment="string",
description="string",
detection_json="string",
groups=["string"],
ifn_regex="string",
name="string",
pattern_id="string",
pattern_name="string")
print(response)

Delete the IOA exclusions by id

DELETE /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 delete_exclusions
NameTypeData typeDescription
commentquerystringExplains why this exclusion was deleted.
idsquerystring or list of stringsThe IDs of the exclusions to retrieve.
parametersquerydictionaryFull query string parameters payload in JSON format.
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)

Update the IOA exclusions

PATCH /policy/entities/ioa-exclusions/v1
Scope IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 update_exclusions
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
cl_regexbodystringCommand line regular expression.
commentbodystringString comment describing why the exclusions was created.
descriptionbodystringExclusion description.
detection_jsonbodystringJSON formatted detection template.
groupsbodylist of stringsGroup ID(s) impacted by the exclusion.
idbodystringID of the exclusion to update.
ifn_regexbodystringIndicator file name regular expression.
namebodystringName of the exclusion.
pattern_idbodystringID of the pattern to use for the exclusion.
pattern_namebodystringName of the pattern to use for the exclusion.
from falconpy import IOAExclusions
falcon = IOAExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_exclusions(cl_regex="string",
comment="string",
description="string",
detection_json="string",
groups=["string"],
id="string",
ifn_regex="string",
name="string",
pattern_id="string",
pattern_name="string")
print(response)

Search for IOA exclusions.

GET /policy/queries/ioa-exclusions/v1
Scope IOA Exclusions: READ Consumes · Produces application/json
PEP 8 query_exclusions
NameTypeData typeDescription
cl_regexquerystringCommand line regular expression.
filterquerystringThe filter expression that should be used to limit the results. FQL syntax. Available filters: name, pattern_id, pattern_name, applied_globally, created_on, created_by, last_modified, modified_by.
ifn_regexquerystringIndicator file name regular expression.
limitqueryintegerThe maximum number of records to return. [1-500]
offsetqueryintegerThe offset to start retrieving records from.
parametersquerydictionaryFull query string parameters payload in JSON format.
sortquerystringThe property to sort by. FQL syntax. (e.g. last_behavior.asc) Available sort fields: name, pattern_id, pattern_name, applied_globally, created_on, created_by, last_modified, modified_by.
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="string",
offset="string",
sort="string")
print(response)

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

POST /exclusions/aggregates/ss-ioa-exclusions/GET/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 get_ss_exclusion_aggregates
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
cl_regexquerystringThe cl_regex expression to filter exclusion aggregations by.
date_rangesbodylist of dictionariesDate range specifications.
excludebodystringExclusion string.
extended_boundsbodydictionaryExtended bounds specification.
fieldbodystringField to aggregate on.
filterbodystringFQL filter expression.
filters_specbodydictionaryFilter specification.
frombodyintegerStarting position.
grandparent_cl_regexquerystringThe grandparent_cl_regex expression to filter exclusion aggregations by.
grandparent_ifn_regexquerystringThe grandparent_ifn_regex expression to filter exclusion aggregations by.
ifn_regexquerystringThe ifn_regex expression to filter exclusion aggregations by.
includebodystringInclude string.
intervalbodystringTime interval for date histogram aggregations.
max_doc_countbodyintegerMaximum document count.
min_doc_countbodyintegerMinimum document count.
missingbodystringMissing value.
namebodystringAggregation name.
parametersquerydictionaryFull query string parameters payload in JSON format.
parent_cl_regexquerystringThe parent_cl_regex expression to filter exclusion aggregations by.
parent_ifn_regexquerystringThe parent_ifn_regex expression to filter exclusion aggregations by.
percentsbodylist of integersPercentile values.
qbodystringFQL syntax query.
rangesbodylist of dictionariesRange specifications.
sizebodyintegerMaximum number of results to return.
sortbodystringSort expression.
sub_aggregatesbodylistSub-aggregation specifications.
time_zonebodystringTime zone for date aggregations.
typebodystringAggregation type.
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)

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

POST /exclusions/entities/ss-ioa-exclusions/reports/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 get_ss_exclusion_reports_v2
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
report_formatbodystringReport format.
searchbodydictionarySearch filter and sort specification.
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)

Get the Self Service IOA Exclusions rules by id.

GET /exclusions/entities/ss-ioa-exclusions/v2
Scope IOA Exclusions: READ Consumes · Produces application/json
PEP 8 get_ss_exclusion_rules_v2
NameTypeData typeDescription
idsquerystring or list of stringsThe IDs of the exclusions to retrieve.
parametersquerydictionaryFull query string parameters payload in JSON format.
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)

Create new Self Service IOA Exclusions.

POST /exclusions/entities/ss-ioa-exclusions/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 create_ss_exclusions
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
exclusionsbodylist of dictionariesList of exclusion definitions.
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)

Update the Self Service IOA Exclusions rule by id.

PATCH /exclusions/entities/ss-ioa-exclusions/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 update_ss_exclusions
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
exclusionsbodylist of dictionariesList of exclusion definitions.
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)

Delete the Self Service IOA Exclusions rule by id.

DELETE /exclusions/entities/ss-ioa-exclusions/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 delete_ss_exclusions
NameTypeData typeDescription
commentquerystringThe comment why these ss ioa exclusions were deleted.
idsquerystring or list of stringsThe IDs of the exclusions to delete.
parametersquerydictionaryFull query string parameters payload in JSON format.
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)

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

POST /exclusions/entities/ss-ioa-matched-rules/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 get_ss_exclusion_matched_rules
NameTypeData typeDescription
aidbodystringAgent ID.
bodybodydictionaryFull body payload in JSON format.
command_linebodystringCommand line.
grandparent_command_linebodystringGrandparent command line.
grandparent_image_file_namebodystringGrandparent image file name.
image_file_namebodystringImage file name.
parent_command_linebodystringParent command line.
parent_image_file_namebodystringParent image file name.
pattern_idsbodylist of stringsPattern IDs.
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)

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

POST /exclusions/entities/ss-ioa-new-rules/v2
Scope Self-Service IOA Exclusions: WRITE Consumes · Produces application/json
PEP 8 get_default_ss_exclusions
NameTypeData typeDescription
aidbodystringAgent ID.
bodybodydictionaryFull body payload in JSON format.
command_linebodystringCommand line.
grandparent_command_linebodystringGrandparent command line.
grandparent_image_file_namebodystringGrandparent image file name.
image_file_namebodystringImage file name.
parent_command_linebodystringParent command line.
parent_image_file_namebodystringParent image file name.
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)

Search for Self Service IOA Exclusions.

GET /exclusions/queries/ss-ioa-exclusions/v2
Scope IOA Exclusions: READ Consumes · Produces application/json
PEP 8 query_ss_exclusions
NameTypeData typeDescription
cl_regexquerystringThe cl_regex expression to filter exclusions by.
filterquerystringThe filter expression that should be used to limit the results.
grandparent_cl_regexquerystringThe grandparent_cl_regex expression to filter exclusions by.
grandparent_ifn_regexquerystringThe grandparent_ifn_regex expression to filter exclusions by.
ifn_regexquerystringThe ifn_regex expression to filter exclusions by.
limitqueryintegerThe maximum records to return. [1-500]
offsetqueryintegerThe offset to start retrieving records from.
parametersquerydictionaryFull query string parameters payload in JSON format.
parent_cl_regexquerystringThe parent_cl_regex expression to filter exclusions by.
parent_ifn_regexquerystringThe parent_ifn_regex expression to filter exclusions by.
sortquerystringThe sort expression that should be used to sort the results.
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)