Skip to content

Drift Indicators

The Drift Indicators service collection provides operations for monitoring and investigating container drift activity. Retrieve drift indicator counts by date, query total counts over time, search and read drift indicator entities by criteria, fetch entities by ID, and query for matching indicator IDs.

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


OperationDescription
GetDriftIndicatorsValuesByDate
get_drift_indicators_by_date
Returns the count of Drift Indicators by the date. by default it’s for 7 days.
ReadDriftIndicatorEntities
read_drift_indicator_entities
Retrieve Drift Indicator entities identified by the provided IDs
ReadDriftIndicatorsCount
read_drift_indicator_counts
Returns the total count of Drift indicators over a time period
SearchAndReadDriftIndicatorEntities
search_and_read_drift_indicators
Retrieve Drift Indicators by the provided search criteria
SearchDriftIndicators
search_drift_indicators
Retrieve all drift indicators that match the given query

Returns the count of Drift Indicators by the date. by default it’s for 7 days.

Method GET
Route /container-security/aggregates/drift-indicators/count-by-date/v1
Scope Falcon Container Image: READ
PEP 8 get_drift_indicators_by_date
filter query · string
Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filter fields:
Available values (16)
cidcloud_namecommand_line
container_idfile_namefile_sha256
host_idindicator_process_idnamespace
occurred_atparent_process_idpod_name
preventedscheduler_nameseverity
worker_node_name
limit query · integer
The upper-bound on the number of records to retrieve.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import DriftIndicators
falcon = DriftIndicators(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_drift_indicators_by_date(filter="string", limit=integer)
print(response)
[
{
"buckets": [],
"name": "string"
}
]


Retrieve Drift Indicator entities identified by the provided IDs

Method GET
Route /container-security/entities/drift-indicators/v1
Scope Falcon Container Image: READ
PEP 8 read_drift_indicator_entities
ids query · string or list of strings
Search Drift Indicators by ids - The maximum amount is 100 IDs
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import DriftIndicators
falcon = DriftIndicators(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.read_drift_indicator_entities(ids=id_list)
print(response)
[
{
"agent_id": "string",
"aid": "string",
"cid": "string",
"cloud_name": "string",
"command_line": "string",
"computer_name": "string",
"container_id": "string",
"detection_description": "string",
"detection_id": "string",
"detection_name": "string",
"file_name": "string",
"host_id": "string",
"indicator_process_id": "string",
"namespace": "string",
"occurred_at": "string",
"parent_process_id": "string",
"pod_id": "string",
"pod_name": "string",
"prevented": false,
"prevention_status": [],
"prevention_status_string": "string",
"scheduler_name": "string",
"severity": "string",
"sha256": "string",
"timestamp": "string"
}
]


Returns the total count of Drift indicators over a time period

Method GET
Route /container-security/aggregates/drift-indicators/count/v1
Scope Falcon Container Image: READ
PEP 8 read_drift_indicator_counts
filter query · string
Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filter fields:
Available values (16)
cidcloud_namecommand_line
container_idfile_namefile_sha256
host_idindicator_process_idnamespace
occurred_atparent_process_idpod_name
preventedscheduler_nameseverity
worker_node_name
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import DriftIndicators
falcon = DriftIndicators(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.read_drift_indicator_counts(filter="string")
print(response)
[
{
"count": 0,
"label": "string"
}
]


Retrieve Drift Indicators by the provided search criteria

Method GET
Route /container-security/combined/drift-indicators/v1
Scope Falcon Container Image: READ
PEP 8 search_and_read_drift_indicators
filter query · string
Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filter fields:
Available values (16)
cidcloud_namecommand_line
container_idfile_namefile_sha256
host_idindicator_process_idnamespace
occurred_atparent_process_idpod_name
preventedscheduler_nameseverity
worker_node_name
sort query · string
The fields to sort the records on.
limit query · integer
The upper-bound on the number of records to retrieve. Maximum limit: 100.
offset query · integer
The offset from where to begin. Maximum offset = 10000 - limit.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import DriftIndicators
falcon = DriftIndicators(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.search_and_read_drift_indicators(filter="string",
limit=integer,
offset=integer,
sort="string")
print(response)
[
{
"agent_id": "string",
"aid": "string",
"cid": "string",
"cloud_name": "string",
"command_line": "string",
"computer_name": "string",
"container_id": "string",
"detection_description": "string",
"detection_id": "string",
"detection_name": "string",
"file_name": "string",
"host_id": "string",
"indicator_process_id": "string",
"namespace": "string",
"occurred_at": "string",
"parent_process_id": "string",
"pod_id": "string",
"pod_name": "string",
"prevented": false,
"prevention_status": [],
"prevention_status_string": "string",
"scheduler_name": "string",
"severity": "string",
"sha256": "string",
"timestamp": "string"
}
]


Retrieve all drift indicators that match the given query

Method GET
Route /container-security/queries/drift-indicators/v1
Scope Falcon Container Image: READ
PEP 8 search_drift_indicators
filter query · string
Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filter fields:
Available values (16)
cidcloud_namecommand_line
container_idfile_namefile_sha256
host_idindicator_process_idnamespace
occurred_atparent_process_idpod_name
preventedscheduler_nameseverity
worker_node_name
sort query · string
The fields to sort the records on.
limit query · integer
The upper-bound on the number of records to retrieve. Maximum limit: 100.
offset query · integer
The offset from where to begin. Maximum offset = 10000 - limit.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import DriftIndicators
falcon = DriftIndicators(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.search_drift_indicators(filter="string",
limit=integer,
offset=integer,
sort="string")
print(response)
[
"string"
]