Skip to content

Sensor Visibility Exclusions

The Sensor Visibility Exclusions service collection provides operations for managing sensor visibility exclusions. Retrieve, create, delete, update, and query exclusions that control which processes are excluded from sensor visibility monitoring.

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
createSVExclusionsV1
create_exclusions
Create the sensor visibility exclusions
deleteSensorVisibilityExclusionsV1
delete_exclusions
Delete the sensor visibility exclusions by id
getSensorVisibilityExclusionsV1
get_exclusions
Get a set of Sensor Visibility Exclusions by specifying their IDs
querySensorVisibilityExclusionsV1
query_exclusions
Search for sensor visibility exclusions.
updateSensorVisibilityExclusionsV1
update_exclusions
Update the sensor visibility exclusions

Create the sensor visibility exclusions

Method POST
Route /policy/entities/sv-exclusions/v1
Scope Sensor Visibility Exclusions: WRITE
PEP 8 create_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
comment body · string
String comment describing why the exclusion is entered.
groups body · array
Group IDs to exclude.
is_descendant_process body · boolean
value body · string
Value to exclude.
from falconpy import SensorVisibilityExclusions
falcon = SensorVisibilityExclusions(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(comment="string",
groups=id_list,
value="string")
print(response)
[
{
"applied_globally": false,
"created_by": "string",
"created_on": "string",
"excluded_from": [],
"groups": [],
"id": "string",
"last_modified": "string",
"modified_by": "string",
"regexp_value": "string",
"value": "string",
"value_hash": "string"
}
]


Delete the sensor visibility exclusions by id

Method DELETE
Route /policy/entities/sv-exclusions/v1
Scope Sensor Visibility 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 SensorVisibilityExclusions
falcon = SensorVisibilityExclusions(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 Sensor Visibility Exclusions by specifying their IDs

Method GET
Route /policy/entities/sv-exclusions/v1
Scope Sensor Visibility 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 SensorVisibilityExclusions
falcon = SensorVisibilityExclusions(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,
"created_by": "string",
"created_on": "string",
"groups": [],
"id": "string",
"is_descendant_process": false,
"last_modified": "string",
"modified_by": "string",
"regexp_value": "string",
"value": "string",
"value_hash": "string"
}
]


Search for sensor visibility exclusions.

Method GET
Route /policy/queries/sv-exclusions/v1
Scope Sensor Visibility 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 (6)
applied_globallycreated_bycreated_on
last_modifiedmodified_byvalue
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 (12)
applied_globally.ascapplied_globally.desccreated_by.asc
created_by.desccreated_on.asccreated_on.desc
last_modified.asclast_modified.descmodified_by.asc
modified_by.descvalue.ascvalue.desc
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import SensorVisibilityExclusions
falcon = SensorVisibilityExclusions(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_exclusions(filter="string",
limit=integer,
offset=integer,
sort="string")
print(response)
[
"string"
]


Update the sensor visibility exclusions

Method PATCH
Route /policy/entities/sv-exclusions/v1
Scope Sensor Visibility Exclusions: WRITE
PEP 8 update_exclusions
body body · dictionary
Full body payload as JSON formatted dictionary.
comment body · string
String comment describing why the exclusion is entered.
groups body · array
Group IDs to exclude.
id body · string
Exclusion ID to update.
is_descendant_process body · boolean
Flag to determine if an exclusion should apply to all descendant processes.
value body · string
Value to exclude.
from falconpy import SensorVisibilityExclusions
falcon = SensorVisibilityExclusions(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(comment="string",
groups=id_list,
id="string",
is_descendant_process=boolean,
value="string")
print(response)
[
{
"applied_globally": false,
"created_by": "string",
"created_on": "string",
"groups": [],
"id": "string",
"is_descendant_process": false,
"last_modified": "string",
"modified_by": "string",
"regexp_value": "string",
"value": "string",
"value_hash": "string"
}
]