Skip to main content

Add case alert evidence

Action ID: tools.crowdstrike.add_case_alert_evidence Attach alerts to a Falcon case as evidence. Requires the Cases: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/case-management/#entitiesalert-evidencepostv1

Input fields

array[map[string, string]]
required
Alerts to attach, as {"id": "<alert composite ID>"} objects.
string
required
Case ID.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Contain hosts

Action ID: tools.crowdstrike.contain_hosts Network-contain hosts, stopping network communications except to the CrowdStrike cloud and IPs allowed by the containment policy. Requires the Hosts: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/hosts/#performactionv2

Input fields

array[string]
required
Host agent IDs (AIDs) to contain.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Create case

Action ID: tools.crowdstrike.create_case Create a Falcon case. Requires the Cases: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/case-management/#entitiescasesputv2

Input fields

object
required
API-native case body, passed through unchanged because optional fields may not accept null. Documented fields: name, severity, description, description_format, status (new, in_progress), assigned_to_user_uuid, tags, template ({"id": ...}), evidence ({"alerts": [{"id": ...}], "events": [{"id": ...}]}), access_tags.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Create IOCs

Action ID: tools.crowdstrike.create_iocs Create custom IOCs. Requires the IOC Management: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ioc/#indicatorcreatev1

Input fields

array[object]
required
Indicators to create. Documented fields: type (sha256, md5, domain, ipv4, ipv6), value, action (no_action, allow, prevent_no_ui, detect, prevent), severity, platforms, applied_globally, host_groups, description, expiration, tags, source, mobile_action, metadata.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
boolean | null
Set to true to ignore warnings and add all IOCs.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
boolean | null
Whether to submit the indicators to retrodetects.Default: null.

Delete IOCs

Action ID: tools.crowdstrike.delete_iocs Delete custom IOCs by ID or FQL filter. If both are provided, filter takes precedence and ids is ignored. Requires the IOC Management: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ioc/#indicatordeletev1

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
Reason the indicators were deleted.Default: null.
string | null
FQL filter to delete indicators in bulk.Default: null.
array[string] | null
Indicator IDs to delete.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Delete RTR session

Action ID: tools.crowdstrike.delete_rtr_session Close a Real Time Response session. Requires the Real time response: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-deletesession

Input fields

string
required
RTR session ID.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get alerts

Action ID: tools.crowdstrike.get_alerts Retrieve Falcon alerts by composite ID. Requires the Alerts: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/alerts/#postentitiesalertsv2

Input fields

array[string]
required
Alert composite IDs, for example from tools.crowdstrike.list_alerts.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get cases

Action ID: tools.crowdstrike.get_cases Retrieve Falcon cases by ID. Requires the Cases: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/case-management/#entitiescasespostv2

Input fields

array[string]
required
Case IDs to retrieve.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get host online state

Action ID: tools.crowdstrike.get_host_online_state Get the online status of one or more hosts. Requires the Hosts: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/hosts/#getonlinestatev1

Input fields

array[string]
required
Host agent IDs (AIDs) to check.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get hosts

Action ID: tools.crowdstrike.get_hosts Get details on one or more hosts by host ID. Requires the Hosts: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/hosts/#getdevicedetails

Input fields

array[string]
required
Host agent IDs (AIDs) to retrieve.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get IOCs

Action ID: tools.crowdstrike.get_iocs Get custom IOCs by ID. Requires the IOC Management: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ioc/#indicatorgetv1

Input fields

array[string]
required
Indicator IDs to retrieve.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get NGSIEM search status

Action ID: tools.crowdstrike.get_ngsiem_search_status Get the status and results of a Falcon Next-Gen SIEM query job. Requires the NGSIEM: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ngsiem/#getsearchstatusv1

Input fields

string
required
Query job ID from tools.crowdstrike.start_ngsiem_search.
string
required
Repository the search was started in.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get quarantined files

Action ID: tools.crowdstrike.get_quarantined_files Get quarantined file metadata by ID. Requires the Quarantined Files: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/quarantine/#getquarantinefiles

Input fields

array[string]
required
Quarantined file IDs.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get RTR active responder command status

Action ID: tools.crowdstrike.get_rtr_active_responder_command_status Get the status and output of an executed RTR active responder command. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-checkactiverespondercommandstatus

Input fields

string
required
Cloud request ID returned when the command was run.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer
Sequence ID to retrieve. Command responses are chunked across sequences.Default: 0.

Get RTR admin command status

Action ID: tools.crowdstrike.get_rtr_admin_command_status Get the status and output of an executed RTR administrator command. Requires the Real time response (admin): Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response-admin/#rtr-checkadmincommandstatus

Input fields

string
required
Cloud request ID returned when the command was run.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer
Sequence ID to retrieve. Command responses are chunked across sequences.Default: 0.

Get RTR batch get command status

Action ID: tools.crowdstrike.get_rtr_batch_get_command_status Get the status of an RTR batch get command, including the session ID and SHA256 of each retrieved file. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#batchgetcmdstatus

Input fields

string
required
Batch get command request ID from run_rtr_batch_get_command.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Seconds to wait for the request. Defaults to 30, maximum 600.Default: null.
string | null
Timeout as a duration, for example 30s. Maximum 10m.Default: null.

Get RTR command status

Action ID: tools.crowdstrike.get_rtr_command_status Get the status and output of an executed RTR read-only command. Requires the Real time response: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-checkcommandstatus

Input fields

string
required
Cloud request ID returned when the command was run.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer
Sequence ID to retrieve. Command responses are chunked across sequences.Default: 0.

Get RTR extracted file

Action ID: tools.crowdstrike.get_rtr_extracted_file Download a file retrieved with the RTR get command. Returns {"content_base64": ...} containing the 7-Zip archive CrowdStrike returns. Files larger than the Tracecat file size limit are rejected. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-getextractedfilecontents

Input fields

string
required
RTR session ID the file was retrieved in.
string
required
SHA256 of the retrieved file.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
Name for the archive and the file inside it.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Get sandbox reports

Action ID: tools.crowdstrike.get_sandbox_reports Get full Falcon Sandbox reports by report ID. Requires the Sandbox (Falcon Intelligence): Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/falconx-sandbox/#getreports

Input fields

array[string]
required
Report IDs, for example from tools.crowdstrike.submit_sandbox_analysis.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Lift host containment

Action ID: tools.crowdstrike.lift_host_containment Lift network containment on hosts, returning their network communications to normal. Requires the Hosts: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/hosts/#performactionv2

Input fields

array[string]
required
Host agent IDs (AIDs) to release from containment.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

List alerts

Action ID: tools.crowdstrike.list_alerts Query for Crowdstrike alerts via the Falcon SIEM API. Reference: https://falconpy.io/Service-Collections/Alerts.html#uber-class-example-7

Input fields

string
required
End time for the query (exclusive).
string
required
Start time for the query (inclusive).
integer
Maximum number of alerts to return.Default: 100.
string | null
Crowdstrike member CID.Default: null.
string | null
Falcon Query Language (FQL) filter to apply to alerts. If specified, overrides start_time and end_time.Default: null.

List cases

Action ID: tools.crowdstrike.list_cases Retrieve the IDs of Falcon cases that match an FQL filter. Use tools.crowdstrike.get_cases for details. Requires the Cases: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/case-management/#queriescasesgetv1

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example status:'new'+created_timestamp:>='2026-01-01T00:00:00Z'.Default: null.
integer | null
Maximum number of case IDs to return. Maximum 10000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Free-text search across case fields.Default: null.
string | null
Property to sort by, for example created_timestamp|desc.Default: null.

List detects

Action ID: tools.crowdstrike.list_detects Deprecated. Query legacy CrowdStrike detects through the Detects API, which CrowdStrike has deprecated in favour of Alerts. Use tools.crowdstrike.list_alerts instead. Reference: https://falconpy.io/Service-Collections/Detects.html Deprecated: Use tools.crowdstrike.list_alerts instead.

Input fields

string
required
End time for the query (exclusive).
string
required
Start time for the query (inclusive).
integer
Maximum number of alerts to return.Default: 100.
string | null
Crowdstrike member CID.Default: null.
string | null
Falcon Query Language (FQL) filter to apply to alerts. If specified, overrides start_time and end_time.Default: null.

List host group members

Action ID: tools.crowdstrike.list_host_group_members Search for the hosts in a host group. Requires the Host groups: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/host-group/#querycombinedgroupmembers

Input fields

string
required
Host group ID.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter to narrow the members returned.Default: null.
integer | null
Maximum number of hosts to return. Maximum 5000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Property to sort by, for example hostname.asc.Default: null.

List host groups

Action ID: tools.crowdstrike.list_host_groups Search for host groups by FQL filter. Requires the Host groups: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/host-group/#querycombinedhostgroups

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example name:'Servers'.Default: null.
integer | null
Maximum number of host groups to return. Maximum 5000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Property to sort by, for example name.asc.Default: null.

List hosts

Action ID: tools.crowdstrike.list_hosts Search for host IDs by platform, hostname, IP, and other criteria. Returns host IDs; use tools.crowdstrike.get_hosts for details. Requires the Hosts: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/hosts/#querydevicesbyfilter

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example hostname:'WIN-*'+platform_name:'Windows'.Default: null.
integer | null
Maximum number of host IDs to return. Maximum 5000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Property to sort by, for example hostname.asc.Default: null.

List hosts for IOC

Action ID: tools.crowdstrike.list_hosts_for_ioc Get the IDs of hosts that observed an indicator. Requires the IOC Management: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ioc/#indicatorgetdevices_ran_onv1

Input fields

string
required
Indicator type: sha256, md5, domain, ipv4, or ipv6.
string
required
Indicator value.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
integer | null
Maximum number of host IDs to return.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
string | null
Pagination offset from the previous response.Default: null.

List incidents

Action ID: tools.crowdstrike.list_incidents Deprecated. Query legacy CrowdStrike incidents through the Incidents API, which CrowdStrike is retiring. Use Case Management actions such as tools.crowdstrike.list_cases instead; cases use a different data model. Reference: https://falconpy.io/Service-Collections/Incidents.html Deprecated: Use tools.crowdstrike.list_cases instead. CrowdStrike is retiring the Incidents API; cases are not a drop-in replacement for incidents.

Input fields

string
required
End time for the query (exclusive).
string
required
Start time for the query (inclusive).
integer
Maximum number of incidents to return.Default: 100.
string | null
Crowdstrike member CID.Default: null.
string | null
Falcon Query Language (FQL) filter to apply to cases. If specified, overrides start_time and end_time.Default: null.

List IOCs

Action ID: tools.crowdstrike.list_iocs Search custom IOCs and return the full indicator records. Requires the IOC Management: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ioc/#indicatorcombinedv1

Input fields

string | null
Pagination token from the previous response’s meta.pagination.after.Default: null.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example type:'domain'+action:'detect'.Default: null.
integer | null
Maximum number of indicators to return.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start from. Mutually exclusive with after; use after beyond 10,000 results.Default: null.
string | null
Property to sort by, for example modified_on.desc.Default: null.

List quarantined files

Action ID: tools.crowdstrike.list_quarantined_files Search quarantined files and return their IDs. Use get_quarantined_files for details. Requires the Quarantined Files: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/quarantine/#queryquarantinefiles

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter.Default: null.
integer | null
Maximum number of results to return.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
string | null
Offset to start from.Default: null.
string | null
Free-text search across all indexed fields.Default: null.
string | null
Property and direction to sort by, for example name.asc.Default: null.

List RTR session files

Action ID: tools.crowdstrike.list_rtr_session_files List the files retrieved with get in an RTR session, including their SHA256s. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-listfilesv2

Input fields

string
required
RTR session ID.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

List vulnerabilities

Action ID: tools.crowdstrike.list_vulnerabilities Search Falcon Spotlight vulnerabilities and return full records. Requires the Vulnerabilities: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/spotlight-vulnerabilities/#combinedqueryvulnerabilities

Input fields

string
required
FQL filter, for example status:'open'+cve.severity:'CRITICAL'. Wildcards and empty filters are not supported.
string | null
Pagination token from the previous response’s meta.pagination.after.Default: null.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
array[string] | null
Extra detail to include, for example cve, host_info, remediation, evaluation_logic.Default: null.
integer | null
Maximum number of vulnerabilities to return. Maximum 5000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
string | null
Property to sort by, for example created_timestamp|desc.Default: null.

Run RTR active responder command

Action ID: tools.crowdstrike.run_rtr_active_responder_command Run a Real Time Response active responder command (for example get, kill, rm) on a host in an open session. Returns a cloud_request_id to poll for output. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-executeactiverespondercommand

Input fields

string
required
Base command to run, for example kill.
string
required
Full command string, including the base command and its arguments.
string
required
RTR session ID from tools.crowdstrike.start_rtr_session.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
boolean
Run the command when an offline host returns to service.Default: false.

Run RTR admin command

Action ID: tools.crowdstrike.run_rtr_admin_command Run a Real Time Response administrator command (for example runscript, put) on a host in an open session. Returns a cloud_request_id to poll for output. Requires the Real time response (admin): Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response-admin/#rtr-executeadmincommand

Input fields

string
required
Base command to run, for example runscript.
string
required
Full command string, including the base command and its arguments.
string
required
RTR session ID from tools.crowdstrike.start_rtr_session.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
boolean
Run the command when an offline host returns to service.Default: false.

Run RTR batch active responder command

Action ID: tools.crowdstrike.run_rtr_batch_active_responder_command Run an active responder RTR command on every host in an RTR batch session and return each host’s output. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#batchactiverespondercmd

Input fields

string
required
Base command to run, for example kill.
string
required
Batch ID from tools.crowdstrike.start_rtr_batch_session.
string
required
Full command string, including the base command and its arguments.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
How long each host has to finish, for example 20s. Must be less than the overall timeout.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
array[string] | null
Subset of host AIDs in the batch to run the command on. Defaults to every host.Default: null.
boolean
Queue the command for hosts that are offline.Default: false.
integer | null
Seconds to wait for the request. Defaults to 30, maximum 600.Default: null.
string | null
Timeout as a duration, for example 30s. Maximum 10m.Default: null.

Run RTR batch admin command

Action ID: tools.crowdstrike.run_rtr_batch_admin_command Run an admin RTR command on every host in an RTR batch session and return each host’s output. Requires the Real time response (admin): Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response-admin/#batchadmincmd

Input fields

string
required
Base command to run, for example runscript.
string
required
Batch ID from tools.crowdstrike.start_rtr_batch_session.
string
required
Full command string, including the base command and its arguments.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
How long each host has to finish, for example 20s. Must be less than the overall timeout.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
array[string] | null
Subset of host AIDs in the batch to run the command on. Defaults to every host.Default: null.
boolean
Queue the command for hosts that are offline.Default: false.
integer | null
Seconds to wait for the request. Defaults to 30, maximum 600.Default: null.
string | null
Timeout as a duration, for example 30s. Maximum 10m.Default: null.

Run RTR batch command

Action ID: tools.crowdstrike.run_rtr_batch_command Run a read-only RTR command on every host in an RTR batch session and return each host’s output. Requires the Real time response: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#batchcmd

Input fields

string
required
Base command to run, for example ls.
string
required
Batch ID from tools.crowdstrike.start_rtr_batch_session.
string
required
Full command string, including the base command and its arguments.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
How long each host has to finish, for example 20s. Must be less than the overall timeout.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
array[string] | null
Subset of host AIDs in the batch to run the command on. Defaults to every host.Default: null.
boolean
Queue the command for hosts that are offline.Default: false.
integer | null
Seconds to wait for the request. Defaults to 30, maximum 600.Default: null.
string | null
Timeout as a duration, for example 30s. Maximum 10m.Default: null.

Run RTR batch get command

Action ID: tools.crowdstrike.run_rtr_batch_get_command Retrieve a file from every host in an RTR batch session. Poll get_rtr_batch_get_command_status for the uploaded file SHA256s. Requires the Real time response: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#batchgetcmd

Input fields

string
required
Batch ID from tools.crowdstrike.start_rtr_batch_session.
string
required
Full path of the file to retrieve from each host.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
How long each host has to finish, for example 20s. Must be less than the overall timeout.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
array[string] | null
Subset of host AIDs in the batch to retrieve from. Defaults to every host.Default: null.
integer | null
Seconds to wait for the request. Defaults to 30, maximum 600.Default: null.
string | null
Timeout as a duration, for example 30s. Maximum 10m.Default: null.

Run RTR command

Action ID: tools.crowdstrike.run_rtr_command Run a read-only Real Time Response command (for example ls, ps, netstat) on a host in an open session. Returns a cloud_request_id to poll for output. Requires the Real time response: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-executecommand

Input fields

string
required
Base command to run, for example ls.
string
required
Full command string, including the base command and its arguments.
string
required
RTR session ID from tools.crowdstrike.start_rtr_session.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
boolean
Run the command when an offline host returns to service.Default: false.

Search intel actors

Action ID: tools.crowdstrike.search_intel_actors Search Falcon Intelligence threat actors by FQL filter or free text. Requires the Actors (Falcon Intelligence): Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/intel/#queryintelactorentities

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example name:'FANCY BEAR'.Default: null.
integer | null
Maximum number of threat actors to return. Maximum 5000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Free-text search across all fields.Default: null.
string | null
Property to sort by, for example created_date|desc.Default: null.

Search intel indicators

Action ID: tools.crowdstrike.search_intel_indicators Search Falcon Intelligence intelligence indicators by FQL filter or free text. Requires the Indicators (Falcon Intelligence): Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/intel/#queryintelindicatorentities

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example indicator:'example.com'.Default: null.
integer | null
Maximum number of intelligence indicators to return. Maximum 10000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Free-text search across all fields.Default: null.
string | null
Property to sort by, for example created_date|desc.Default: null.

Search intel reports

Action ID: tools.crowdstrike.search_intel_reports Search Falcon Intelligence intelligence reports by FQL filter or free text. Requires the Reports (Falcon Intelligence): Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/intel/#queryintelreportentities

Input fields

string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
FQL filter, for example actors.name:'FANCY BEAR'.Default: null.
integer | null
Maximum number of intelligence reports to return. Maximum 5000.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
integer | null
Offset to start retrieving records from.Default: null.
string | null
Free-text search across all fields.Default: null.
string | null
Property to sort by, for example created_date|desc.Default: null.
Action ID: tools.crowdstrike.start_ngsiem_search Start an asynchronous Falcon Next-Gen SIEM (LogScale) query job. Returns a job ID to poll with tools.crowdstrike.get_ngsiem_search_status. Requires the NGSIEM: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/ngsiem/#startsearchv1

Input fields

string
required
CrowdStrike Query Language (CQL) query.
string
required
Repository to search, for example search-all or investigate_view.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
string
Search start, as a relative time such as 1d or epoch milliseconds. The search ends now.Default: "1d".

Start RTR batch session

Action ID: tools.crowdstrike.start_rtr_batch_session Start Real Time Response sessions on many hosts at once and return a batch ID for the batch command actions. Keep it alive with refresh_rtr_batch_session. Requires the Real time response: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#batchinitsessions

Input fields

array[string]
required
Host AIDs to start sessions on.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
Existing batch ID to add the hosts to.Default: null.
string | null
How long each host has to finish, for example 20s. Must be less than the overall timeout.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
boolean
Queue commands for hosts that are offline.Default: false.
integer | null
Seconds to wait for the request. Defaults to 30, maximum 600.Default: null.
string | null
Timeout as a duration, for example 30s. Maximum 10m.Default: null.

Start RTR session

Action ID: tools.crowdstrike.start_rtr_session Initialize a Real Time Response session on a host. Returns the session ID used by the RTR command actions. Requires the Real time response: Read API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/real-time-response/#rtr-initsession

Input fields

string
required
Host agent ID (AID) to open the session on.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.
boolean
Queue commands to run when an offline host comes back online.Default: false.

Submit sandbox analysis

Action ID: tools.crowdstrike.submit_sandbox_analysis Submit an uploaded file or a URL for Falcon Sandbox analysis. Requires the Sandbox (Falcon Intelligence): Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/falconx-sandbox/#submit

Input fields

array[object]
required
Submissions. Documented fields: sha256 (of an uploaded sample) or url, environment_id (for example 160 for Windows 10 64-bit), action_script, command_line, document_password, network_settings, submit_name, system_date, system_time.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Update alerts

Action ID: tools.crowdstrike.update_alerts Perform actions on Falcon alerts identified by composite ID, such as changing status, assigning, tagging, or commenting. Requires the Alerts: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/alerts/#patchentitiesalertsv3

Input fields

array[map[string, string]]
required
Actions to apply, as {"name": ..., "value": ...} objects. Documented names: update_status (new, in_progress, closed, reopened), assign_to_uuid, assign_to_name, assign_to_user_id, unassign, append_comment, add_tag, remove_tag, remove_tags_by_prefix, show_in_ui, new_behavior_processed.
array[string]
required
Composite IDs of the alerts to update.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Update case

Action ID: tools.crowdstrike.update_case Update fields on a Falcon case. Requires the Cases: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/case-management/#entitiescasespatchv2

Input fields

object
required
Fields to update. Documented fields include name, description, description_format, status, severity, assigned_to_user_uuid, remove_user_assignment, and template.
string
required
Case ID.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Update host group members

Action ID: tools.crowdstrike.update_host_group_members Add hosts to, or remove hosts from, static host groups. Requires the Host groups: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/host-group/#performgroupaction

Input fields

string
required
Action to perform: add-hosts or remove-hosts.
array[map[string, string]]
required
Action parameters, as {"name": ..., "value": ...} objects. Use name filter with an FQL host filter, for example {"name": "filter", "value": "(device_id:['<aid>'])"}.
array[string]
required
Host group IDs to update.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Update host tags

Action ID: tools.crowdstrike.update_host_tags Add or remove Falcon Grouping Tags on one or more hosts. Requires the Hosts: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/hosts/#updatedevicetags

Input fields

string
required
Action to perform: add or remove.
array[string]
required
Host agent IDs (AIDs) to update.
array[string]
required
Falcon Grouping Tags, for example FalconGroupingTags/quarantine.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.

Update quarantined files

Action ID: tools.crowdstrike.update_quarantined_files Release, unrelease or permanently delete quarantined files by ID. Requires the Quarantined Files: Write API scope. Reference: https://developer.crowdstrike.com/api-reference/collections/quarantine/#updatequarantineddetectsbyids

Input fields

string
required
Action: release, unrelease or delete.
array[string]
required
Quarantined file IDs.
string | null
Falcon API base URL. Defaults to the crowdstrike.base_url workspace variable, then FalconPy’s US-1 default.Default: null.
string | null
Audit log comment.Default: null.
string | null
CrowdStrike child CID to act on, for Flight Control (MSSP) parent tenants.Default: null.