CrowdstrikeFalcon
The CrowdStrike Falcon OAuth 2 API (formerly the Falcon Firehose API), enables fetching and resolving detections, searching devices, getting behaviors by ID, containing hosts, and lifting host containment.
Endpoint · CrowdStrike Falcon
Details
| ID | CrowdstrikeFalcon |
|---|---|
| Provider | CrowdStrike |
| Category | Endpoint |
| From Version | 5.0.0 |
| Docker Image | demisto/py3-tools:1.0.0.10120494 |
| Supported Modules | Agentix XSIAM EDR Cortex Cloud Cloud Runtime Security Exposure Management |
README
The CrowdStrike Falcon OAuth 2 API (formerly the Falcon Firehose API), enables fetching and resolving detections, searching devices, getting behaviors by ID, containing hosts, and lifting host containment.
Configure CrowdStrike Falcon in Cortex
| Parameter | Description | Required |
|---|---|---|
| Server URL (e.g., https://api.crowdstrike.com) | True | |
| Client ID | False | |
| Secret | False | |
| Source Reliability | Reliability of the source providing the intelligence data. Currently used for “CVE” reputation command. | False |
| Fetch incidents | False | |
| Incident Fetch types | Choose what incident types to fetch - You can choose any combination. Note: Records from the detection endpoint of the CrowdStrike Falcon UI could be of types: ‘Endpoint Detection’ and ‘OFP Detection’. |
False |
| Incident type | False | |
| First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days) | Supported in Cortex XSOAR and Cortex Platform. | False |
| Max incidents per fetch | Supported in Cortex XSOAR and Cortex Platform. Input a value between 1-500. Default is 15. | False |
| Incidents Fetch Interval | Supported in Cortex XSOAR and Cortex Platform. | False |
| Advanced: Time in minutes to look back when fetching incidents and detections | Use this parameter to determine the look-back period for searching for incidents that were created before the last run time and did not match the query when they were created. | False |
| Endpoint Detections filter query | Use the Falcon Query Language to refine the data collected. For more information, refer to the FQL syntax documentation: https://www.falconpy.io/Usage/Falcon-Query-Language.html | False |
| IDP Detections filter query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| Mobile Detections filter query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| IOM filter query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| IOA filter query | The Indicator of Attack (IOA) fetch query. This is an FQL filter that is combined with the time-range filter using AND. For example: cloud_provider:’aws’. For more information, see the Falcon Query Language (FQL) documentation at: https://www.falconpy.io/Usage/Falcon-Query-Language.html. | False |
| Detections from On-Demand Scans filter query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| OFP Detections filter query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| Third Party Detection fetch query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| NGSIEM Detection fetch query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| NGSIEM automated leads fetch query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| NGSIEM cases fetch query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| NGSIEM incidents fetch query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| Recon filter query | Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html). | False |
| Mirroring Direction | Choose the direction to mirror the detection: Incoming (from CrowdStrike Falcon to Cortex XSOAR), Outgoing (from Cortex XSOAR to CrowdStrike Falcon), or Incoming and Outgoing (to/from CrowdStrike Falcon and Cortex XSOAR). | False |
| Close Mirrored XSOAR Incident | When selected, closing the CrowdStrike Falcon incident is mirrored in Cortex XSOAR. | False |
| Close Mirrored CrowdStrike Falcon Incident or Detection | When selected, closing the Cortex XSOAR incident is mirrored in CrowdStrike Falcon, according to the types that were chosen to be fetched and mirrored. | False |
| Reopen Statuses | CrowdStrike Falcon statuses that will reopen an incident in Cortex XSOAR if closed. You can choose any combination. | False |
| Fetch events | False | |
| Event Fetch types | Choose what event types to fetch - You can choose any combination. Note: Records from the detection endpoint of the CrowdStrike Falcon UI could be of types: ‘Endpoint Detection’ and ‘OFP Detection’. | False |
| Events Fetch Interval | False | |
| Advanced: Time in minutes to look back when fetching events and detections | Use this parameter to determine the look-back period for searching for events that were created before the last run time and did not match the query when they were created. | False |
| Fetch assets and vulnerabilities | False | |
| Fetch Asset types | The asset sources to ingest into the Cortex Unified Asset Inventory. | False |
| Assets Fetch Interval | The fetch interval for assets and vulnerabilities. It is recommended to set it to 1 hour. | False |
| Trust any certificate (not secure) | False | |
| Use system proxy settings | False |
Required API client scope
In order to use the CrowdStrike Falcon integration, the API client must have the following scope and permissions:
-
Real Time Response - Read and Write - Real Time Response Admin - Write
- Alerts - Read and Write
- IOC Manager - Read and Write
- IOCs - Read and Write
- IOA Exclusions - Read and Write
- Machine Learning Exclusions - Read and Write
- Detections - Read and Write
- Hosts - Read and Write
- Host Groups - Read and Write
- Incidents - Read and Write
- Spotlight Vulnerabilities - Read
- User Management - Read
- On-Demand Scans (ODS) - Read and Write
- Identity Protection Entities - Read and Write
- Identity Protection Detections - Read and Write
- Identity Protection Timeline - Read
- Identity Protection Assessment - Read
- Falcon Container Image - Read
- Recon - Read and Write
- Workflow - Read and Write
Incident Mirroring (Cortex XSOAR Only)
You can enable incident mirroring between Cortex XSOAR incidents and CrowdStrike Falcon corresponding events (available from Cortex XSOAR version 6.0.0).
To set up the mirroring:
- Enable Fetching incidents in your instance configuration.
- In the Fetch types integration parameter, select what types to mirror.
- Optional: You can go to one of the fetch query parameters and select the query to fetch the events from CrowdStrike Falcon.
-
In the Mirroring Direction integration parameter, select in which direction the incidents should be mirrored:
Option Description None Turns off incident mirroring. Incoming Any changes in CrowdStrike Falcon events (mirroring incoming fields) will be reflected in Cortex XSOAR incidents. Outgoing Any changes in Cortex XSOAR incidents will be reflected in CrowdStrike Falcon events (outgoing mirrored fields). Incoming And Outgoing Changes in Cortex XSOAR incidents and CrowdStrike Falcon events will be reflected in both directions. - Optional: Check the Close Mirrored XSOAR Incident integration parameter to close the Cortex XSOAR incident when the corresponding event is closed in CrowdStrike Falcon.
- Optional: Check the Close Mirrored CrowdStrike Falcon Incident or Detection integration parameter to close the CrowdStrike Falcon incident or detection when the corresponding Cortex XSOAR incident is closed.
Newly fetched Cortex XSOAR incidents will be mirrored in the chosen direction. However, this selection does not affect existing incidents.
Important Notes
- To ensure the mirroring works as expected, mappers are required, both for incoming and outgoing, to map the expected fields in Cortex XSOAR and CrowdStrike Falcon.
- When mirroring in incidents from CrowdStrike Falcon to Cortex XSOAR:
- For the
tagsfield, tags can only be added from the remote system. - When enabling the Close Mirrored XSOAR Incident integration parameter, the field in CrowdStrike Falcon that determines whether the incident was closed is the
statusfield. - In case the look-back parameter is initialized with a certain value and during a time that incidents were fetched, if changing
the lookback to a number that is greater than the previous value, then in the initial incident fetching there will be incidents duplications.
If the integration was already set with lookback > 0, and the lookback is not being increased at any point of time, then those incident duplications would not occur.
- For the
Fetch Incidents (Cortex XSOAR Only)
CrowdStrike Falcon incidents or detections can be fetched as incidents in Cortex XSOAR.
Users can specify a fetch query per CrowdStrike Falcon fetch type when configuring the integration instance to control which records are fetched.
Indicator of Misconfiguration (IOM) Fetch Query
The IOM Fetch query relies on an FQL filter expression.
Available filters:
use_current_scan_ids(use this to get records for latest scans)account_nameaccount_idagent_idattack_typesazure_subscription_idcloud_providercloud_service_keywordcustom_policy_idis_managedpolicy_idpolicy_typeresource_idregionstatusseverityseverity_string
For example: cloud_provider: 'aws'+account_id: 'my_id'
Indicator of Attack (IOA) Fetch Query
Indicator of Attack (IOA) fetch query. An FQL filter that will be combined with the time-range filter using AND. For example: cloud_provider:'aws'. For more information, see the FQL Syntax Documentation.
Fetch Assets
CrowdStrike Falcon assets and vulnerabilities can be fetched and ingested into the Cortex XSIAM Unified Asset Inventory (UAI).
Select the desired method in the Fetch Assets Type parameter:
- Spotlight: Fetches vulnerabilities from the Spotlight Vulnerabilities Endpoint and enriches them with the associated host details. Both the vulnerabilities and the corresponding assets are ingested into the Unified Asset Inventory. Only vulnerabilities updated within the last 100 days are retrieved, keeping each collection focused on recent data.
- CNAPP Alerts: Fetches Cloud Native Application Protection Platform (CNAPP) alerts as assets.
Commands
You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
cs-falcon-search-device
Searches for a device that matches the query.
Base Command
cs-falcon-search-device
Input
| Argument Name | Description | Required |
|---|---|---|
| extended_data | Whether or not to get additional data about the device. Possible values are: Yes, No. | Optional |
| filter | The query by which to filter the device. The query format should be filter_parameter_name:'filter_value'. |
Optional |
| limit | The maximum records to return [1-5000]. Default is 50. | Optional |
| offset | The offset to start retrieving records from. | Optional |
| ids | A comma-separated list of device IDs to limit the results. | Optional |
| status | The status of the device. Possible values are: normal, containment_pending, contained, lift_containment_pending. | Optional |
| hostname | The hostname of the device. | Optional |
| platform_name | The platform name of the device. Possible values are: Windows, Mac, Linux. | Optional |
| site_name | The site name of the device. | Optional |
| sort | The property to sort by (e.g., status.desc or hostname.asc). | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Device.ID | String | The ID of the device. |
| CrowdStrike.Device.LocalIP | String | The local IP address of the device. |
| CrowdStrike.Device.ExternalIP | String | The external IP address of the device. |
| CrowdStrike.Device.Hostname | String | The hostname of the device. |
| CrowdStrike.Device.OS | String | The operating system of the device. |
| CrowdStrike.Device.MacAddress | String | The MAC address of the device. |
| CrowdStrike.Device.FirstSeen | String | The first time the device was seen. |
| CrowdStrike.Device.LastSeen | String | The last time the device was seen. |
| CrowdStrike.Device.PolicyType | String | The policy type of the device. |
| CrowdStrike.Device.Status | String | The device status. |
| Endpoint.Hostname | String | The endpoint hostname. |
| Endpoint.OS | String | The endpoint operation system. |
| Endpoint.IPAddress | String | The endpoint IP address. |
| Endpoint.ID | String | The endpoint ID. |
| Endpoint.Status | String | The endpoint status. |
| Endpoint.IsIsolated | String | The endpoint isolation status. |
| Endpoint.MACAddress | String | The endpoint MAC address. |
| Endpoint.Vendor | String | The integration name of the endpoint vendor. |
| Endpoint.OSVersion | String | The endpoint operation system version. |
Command Example
!cs-falcon-search-device ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1,a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Context Example
{
"CrowdStrike": {
"Device": [
{
"ExternalIP": "94.188.164.68",
"MacAddress": "8c-85-90-3d-ed-3e",
"Hostname": "154.132.82-test-co.in-addr.arpa",
"LocalIP": "192.168.1.76",
"LastSeen": "2019-03-28T02:36:41Z",
"OS": "Mojave (10.14)",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"FirstSeen": "2017-12-28T22:38:11Z",
"Status": "contained"
},
{
"ExternalIP": "94.188.164.68",
"MacAddress": "f0-18-98-74-8c-31",
"Hostname": "154.132.82-test-co.in-addr.arpa",
"LocalIP": "172.22.14.237",
"LastSeen": "2019-03-17T10:03:17Z",
"OS": "Mojave (10.14)",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"FirstSeen": "2017-12-10T11:01:20Z",
"Status": "contained"
}
]
},
"Endpoint": [
{
"Hostname": "154.132.82-test-co.in-addr.arpa",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"IPAddress": "192.168.1.76",
"OS": "Mojave (10.14)",
"Status": "Online",
"Vendor": "CrowdStrike Falcon",
"MACAddress": "1-1-1-1"
},
{
"Hostname": "154.132.82-test-co.in-addr.arpa",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"IPAddress": "172.22.14.237",
"OS": "Mojave (10.14)",
"Status": "Online",
"Vendor": "CrowdStrike Falcon",
"MACAddress": "1-1-1-1"
}
]
}
Human Readable Output
Devices
ID Hostname OS Mac Address Local IP External IP First Seen Last Seen Status a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 154.132.82-test-co.in-addr.arpa Mojave (10.14) 8c-85-90-3d-ed-3e 192.168.1.76 94.188.164.68 2017-12-28T22:38:11Z 2019-03-28T02:36:41Z contained a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 154.132.82-test-co.in-addr.arpa Mojave (10.14) f0-18-98-74-8c-31 172.22.14.237 94.188.164.68 2017-12-10T11:01:20Z 2019-03-17T10:03:17Z contained
cs-falcon-search-detection
Search for details of specific detections, either using a filter query, or by providing the IDs of the detections.
Base Command
cs-falcon-search-detection
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of IDs of the detections to search. If provided, will override other arguments. | Optional |
| filter | Filter detections using a query in Falcon Query Language (FQL). For example, filter=”device.hostname:’CS-SE-TG-W7-01’“ For a full list of valid filter options, see: https://falcon.crowdstrike.com/support/documentation/2/query-api-reference#detectionsearch. Default is product:’epp’+type:’ldt’. |
Optional |
| extended_data | Whether to get additional data such as device and behaviors processed. Possible values are: Yes, No. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Detection.Behavior.FileName | String | The filename of the behavior. |
| CrowdStrike.Detection.Behavior.Scenario | String | The scenario name of the behavior. |
| CrowdStrike.Detection.Behavior.MD5 | String | The MD5 hash of the IOC of the behavior. |
| CrowdStrike.Detection.Behavior.SHA256 | String | The SHA256 hash of the IOC of the behavior. |
| CrowdStrike.Detection.Behavior.IOCType | String | The type of the IOC. |
| CrowdStrike.Detection.Behavior.IOCValue | String | The value of the IOC. |
| CrowdStrike.Detection.Behavior.CommandLine | String | The command line executed in the behavior. |
| CrowdStrike.Detection.Behavior.UserName | String | The username related to the behavior. |
| CrowdStrike.Detection.Behavior.SensorID | String | The sensor ID related to the behavior. |
| CrowdStrike.Detection.Behavior.ParentProcessID | String | The ID of the parent process. |
| CrowdStrike.Detection.Behavior.ProcessID | String | The process ID of the behavior. |
| CrowdStrike.Detection.Behavior.ID | String | The ID of the behavior. |
| CrowdStrike.Detection.System | String | The system name of the detection. |
| CrowdStrike.Detection.CustomerID | String | The ID of the customer (CID). |
| CrowdStrike.Detection.MachineDomain | String | The name of the domain of the detection machine. |
| CrowdStrike.Detection.ID | String | The detection ID. |
| CrowdStrike.Detection.ProcessStartTime | Date | The start time of the process that generated the detection. |
Command Example
!cs-falcon-search-detection filter="product:'idp'"
!cs-falcon-search-detection filter="product:'mobile'"
!cs-falcon-search-detection filter="product:'ngsiem'"
!cs-falcon-search-detection filter="product:'thirdparty'"
!cs-falcon-search-detection ids=ldt:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1:1898376850347,ldt:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1:1092318056279064902
Context Example
{
"CrowdStrike": {
"Detection": [
{
"Status": "false_positive",
"ProcessStartTime": "2019-03-21T20:32:55.654489974Z",
"Behavior": [
{
"IOCType": "domain",
"ProcessID": "2279170016592",
"Scenario": "intel_detection",
"ParentProcessID": "2257232915544",
"CommandLine": "C:\\Python27\\pythonw.exe -c __import__('idlelib.run').run.main(True) 1250",
"UserName": "josh",
"FileName": "pythonw.exe",
"SensorID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ID": "4900",
"IOCValue": "systemlowcheck.com",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
},
{
"IOCType": "domain",
"ProcessID": "2283087267593",
"Scenario": "intel_detection",
"ParentProcessID": "2279170016592",
"CommandLine": "ping.exe systemlowcheck.com",
"UserName": "josh",
"FileName": "PING.EXE",
"SensorID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ID": "4900",
"IOCValue": "systemlowcheck.com",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
],
"MaxSeverity": 70,
"System": "DESKTOP-S49VMIL",
"ID": "ldt:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1:1898376850347",
"MachineDomain": "",
"ShowInUi": true,
"CustomerID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
},
{
"Status": "new",
"ProcessStartTime": "2019-02-04T07:05:57.083205971Z",
"Behavior": [
{
"IOCType": "sha256",
"ProcessID": "201917905370426448",
"Scenario": "known_malware",
"ParentProcessID": "201917902773103685",
"CommandLine": "./xSf",
"UserName": "user@u-MacBook-Pro-2.local",
"FileName": "xSf",
"SensorID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ID": "3206",
"IOCValue": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
},
{
"IOCType": "sha256",
"ProcessID": "201917905370426448",
"Scenario": "known_malware",
"ParentProcessID": "201917902773103685",
"CommandLine": "./xSf",
"UserName": "user@u-MacBook-Pro-2.local",
"FileName": "xSf",
"SensorID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ID": "3206",
"IOCValue": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
],
"MaxSeverity": 30,
"System": "u-MacBook-Pro-2.local",
"ID": "ldt:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1:1092318056279064902",
"MachineDomain": "",
"ShowInUi": true,
"CustomerID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
]
}
}
Human Readable Output
Detections Found
ID Status System Process Start Time Customer ID Max Severity ldt:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1:1898376850347 false_positive DESKTOP-S49VMIL 2019-03-21T20:32:55.654489974Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 70 ldt:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1:1092318056279064902 new u-MacBook-Pro-2.local 2019-02-04T07:05:57.083205971Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 30
cs-falcon-resolve-detection
Resolves and updates a detection using the provided arguments. At least one optional argument must be passed, otherwise no change will take place. Note that IDP detections are not supported.
Base Command
cs-falcon-resolve-detection
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of one or more IDs to resolve. | Required |
| status | The status to transition a detection to. Possible values are: new, in_progress, closed, reopened. | Optional |
| assigned_to_uuid | A user ID, for example: 1234567855512345678. username and assigned_to_uuid are mutually exclusive. | Optional |
| comment | Optional comment to add to the detection. Comments are displayed with the detection in CrowdStrike Falcon and provide context or notes for other Falcon users. | Optional |
| show_in_ui | If true, displays the detection in the UI. Possible values are: true, false. | Optional |
| username | Username to assign the detections to. (This is usually the user’s email address, but may vary based on your configuration). username and assigned_to_uuid are mutually exclusive. | Optional |
| tag | The tag to add to the detection, supported only for API V3. | Optional |
Context Output
There is no context output for this command.
cs-falcon-contain-host
Contains containment for a specified host. When contained, a host can only communicate with the CrowdStrike cloud and any IPs specified in your containment policy.
Base Command
cs-falcon-contain-host
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of host agent IDs (AID) of the host to contain. Get an agent ID from a detection. | Required |
Context Output
There is no context output for this command.
cs-falcon-lift-host-containment
Lifts containment on the host, which returns its network communications to normal. When lift_filesystem_containment_all is set to true, lifts filesystem containment instead.
Base Command
cs-falcon-lift-host-containment
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of host agent IDs (AIDs) of the hosts to contain. Get an agent ID from a detection. | Required |
| lift_filesystem_containment_all | Whether to lift filesystem containment instead of network containment. When set to true, uses the lift_filesystem_containment_all action to remove filesystem containment from the specified hosts. Possible values are: true, false. Default is false. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-lift-host-containment ids="a]1234567890abcdef12345678"
Human Readable Output
Containment has been lifted off host ‘a]1234567890abcdef12345678’
cs-falcon-run-command
Sends commands to hosts.
Base Command
cs-falcon-run-command
Input
| Argument Name | Description | Required |
|---|---|---|
| queue_offline | Any commands run against an offline-queued session will be queued up and executed when the host comes online. | Optional |
| host_ids | A comma-separated list of host agent IDs to run commands for. The list of host agent IDs can be retrieved by running the ‘cs-falcon-search-device’ command. | Required |
| command_type | The type of command to run. | Required |
| full_command | The full command to run. | Required |
| scope | The scope to run the command for. (NOTE: In order to run the CrowdStrike RTR put command, it is necessary to pass scope=admin). Possible values are: read, write, admin. Default is read. |
Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. Default is 180. | Optional |
| target | The target to run the command for. Possible values are: batch, single. Default is batch. | Optional |
| batch_id | A batch ID to execute the command on. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.HostID | String | The ID of the host the command was running for. |
| CrowdStrike.Command.SessionID | string | The session ID of the host. |
| CrowdStrike.Command.Stdout | String | The standard output of the command. |
| CrowdStrike.Command.Stderr | String | The standard error of the command. |
| CrowdStrike.Command.BaseCommand | String | The base command. |
| CrowdStrike.Command.FullCommand | String | The full command. |
| CrowdStrike.Command.TaskID | string | (For single host) The ID of the command request which has been accepted. |
| CrowdStrike.Command.Complete | boolean | (For single host) True if the command completed. |
| CrowdStrike.Command.NextSequenceID | number | (For single host) The next sequence ID. |
| CrowdStrike.Command.BatchID | String | The Batch ID that the command was executed on. |
Command Example
cs-falcon-run-command host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 command_type=ls full_command="ls C:\\"
Context Example
{
'CrowdStrike': {
'Command': [{
'HostID': 'a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1',
'Stdout': 'Directory listing for C:\\ -\n\n'
'BatchID': 'batch_id'
'Name Type Size (bytes) Size (MB) '
'Last Modified (UTC-5) Created (UTC-5) \n---- '
' ---- ------------ --------- --------------------- -------'
'-------- \n$Recycle.Bin <Directory> -- '
' -- 11/27/2018 10:54:44 AM 9/15/2017 3:33:40 AM \nITAYDI '
' <Directory> -- -- 11/19/2018 1:'
'31:42 PM 11/19/2018 1:31:42 PM ',
'Stderr': '',
'BaseCommand': 'ls',
'Command': 'ls C:\\'
}]
}
Human Readable Output
Command ls C:\ results
BaseCommand Command HostID Stderr Stdout BatchID ls ls C:\ a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 Directory listing for C:\ -
Name Type Size (bytes) Size (MB) Last Modified (UTC-5) Created (UTC-5)
—- —- ———— ——— ——————— —————
$Recycle.Bin <Directory> – – 11/27/2018 10:54:44 AM 9/15/2017 3:33:40 AM
ITAYDI <Directory> – – 11/19/2018 1:31:42 PM 11/19/2018 1:31:42 PMbatch_id
cs-falcon-upload-script
Uploads a script to Falcon CrowdStrike.
Base Command
cs-falcon-upload-script
Input
| Argument Name | Description | Required |
|---|---|---|
| name | The script name to upload. | Required |
| permission_type | The permission type for the custom script. Possible values are: “private”, which is used only by the user who uploaded it, “group”, which is used by all RTR Admins, and “public”, which is used by all active-responders and RTR admins. Possible values are: private, group, public. Default is private. | Optional |
| content | The content of the PowerShell script. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-upload-script name=greatscript content="Write-Output 'Hello, World!'"
Human Readable Output
The script was uploaded successfully.
Context Output
There is no context output for this command.
cs-falcon-upload-file
Uploads a file to the CrowdStrike cloud. (Can be used for the RTR ‘put’ command).
Base Command
cs-falcon-upload-file
Input
| Argument Name | Description | Required |
|---|---|---|
| entry_id | The file entry ID to upload. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-upload-file entry_id=4@4
Human Readable Output
The file was uploaded successfully.
Context Output
There is no context output for this command.
cs-falcon-delete-file
Deletes a file based on the provided ID or name. Can delete only one file at a time.
Base Command
cs-falcon-delete-file
Input
| Argument Name | Description | Required |
|---|---|---|
| file_id | The ID of the file to delete. Either this argument or file_name is required. When both are specified, file_id takes precedence. | Optional |
| file_name | The name of the file to delete. Either this argument or file_id is required. When both are specified, file_id takes precedence. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-delete-file file_id=le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Human Readable Output
File le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 was deleted successfully.
Context Output
There is no context output for this command.
cs-falcon-get-file
Returns files based on the provided IDs. These files are used for the RTR ‘put’ command.
Base Command
cs-falcon-get-file
Input
| Argument Name | Description | Required |
|---|---|---|
| file_id | A comma-separated list of file IDs to get. The list of file IDs can be retrieved by running the ‘cs-falcon-list-files’ command. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.File.ID | String | The ID of the file. |
| CrowdStrike.File.CreatedBy | String | The email address of the user who created the file. |
| CrowdStrike.File.CreatedTime | Date | The datetime the file was created. |
| CrowdStrike.File.Description | String | The description of the file. |
| CrowdStrike.File.Type | String | The type of the file. For example, script. |
| CrowdStrike.File.ModifiedBy | String | The email address of the user who modified the file. |
| CrowdStrike.File.ModifiedTime | Date | The datetime the file was modified. |
| CrowdStrike.File.Name | String | The full name of the file. |
| CrowdStrike.File.Permission | String | The permission type of the file. Possible values are: “private”, which is used only by the user who uploaded it, “group”, which is used by all RTR Admins, and “public”, which is used by all active-responders and RTR admins. |
| CrowdStrike.File.SHA256 | String | The SHA-256 hash of the file. |
| File.Type | String | The file type. |
| File.Name | String | The full name of the file. |
| File.SHA256 | String | The SHA-256 hash of the file. |
| File.Size | Number | The size of the file in bytes. |
Command Example
!cs-falcon-get-file file_id=le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Context Example
{
"CrowdStrike": {
"File": {
"CreatedBy": "spongobob@demisto.com",
"CreatedTime": "2019-10-17T13:41:48.487520845Z",
"Description": "Demisto",
"ID": "le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "spongobob@demisto.com",
"ModifiedTime": "2019-10-17T13:41:48.487521161Z",
"Name": "Demisto",
"Permission": "private",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Type": "script"
}
}
}
Human Readable Output
CrowdStrike Falcon file le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
CreatedBy CreatedTime Description ID ModifiedBy ModifiedTime Name Permission SHA256 Type spongobob@demisto.com 2019-10-17T13:41:48.487520845Z Demisto le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 spongobob@demisto.com 2019-10-17T13:41:48.487521161Z Demisto private a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 script
cs-falcon-list-files
Returns a list of put-file IDs that are available for the user in the ‘put’ command. Due to an API limitation, the maximum number of files returned is 100.
Base Command
cs-falcon-list-files
Input
| Argument Name | Description | Required |
| — | — | — |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.File.ID | String | The ID of the file. |
| CrowdStrike.File.CreatedBy | String | The email address of the user who created the file. |
| CrowdStrike.File.CreatedTime | Date | The datetime the file was created. |
| CrowdStrike.File.Description | String | The description of the file. |
| CrowdStrike.File.Type | String | The type of the file. For example, script. |
| CrowdStrike.File.ModifiedBy | String | The email address of the user who modified the file. |
| CrowdStrike.File.ModifiedTime | Date | The datetime the file was modified. |
| CrowdStrike.File.Name | String | The full name of the file. |
| CrowdStrike.File.Permission | String | The permission type of the file. Possible values are: “private”, which is used only by the user who uploaded it, “group”, which is used by all RTR Admins, and “public”, which is used by all active-responders and RTR admins. |
| CrowdStrike.File.SHA256 | String | The SHA-256 hash of the file. |
| File.Type | String | The file type. |
| File.Name | String | The full name of the file. |
| File.SHA256 | String | The SHA-256 hash of the file. |
| File.Size | Number | The size of the file in bytes. |
Command Example
!cs-falcon-list-files
Context Example
{
"CrowdStrike": {
"File": [
{
"CreatedBy": "spongobob@demisto.com",
"CreatedTime": "2019-10-17T13:41:48.487520845Z",
"Description": "Demisto",
"ID": "le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "spongobob@demisto.com",
"ModifiedTime": "2019-10-17T13:41:48.487521161Z",
"Name": "Demisto",
"Permission": "private",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Type": "script"
}
]
}
}
Human Readable Output
CrowdStrike Falcon files
CreatedBy CreatedTime Description ID ModifiedBy ModifiedTime Name Permission SHA256 Type spongobob@demisto.com 2019-10-17T13:41:48.487520845Z Demisto le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 spongobob@demisto.com 2019-10-17T13:41:48.487521161Z Demisto private a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 script
cs-falcon-get-script
Returns custom scripts based on the provided ID. Used for the RTR ‘runscript’ command.
Base Command
cs-falcon-get-script
Input
| Argument Name | Description | Required |
|---|---|---|
| script_id | A comma-separated list of script IDs to return. The script IDs can be retrieved by running the ‘cs-falcon-list-scripts’ command. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Script.ID | String | The ID of the script. |
| CrowdStrike.Script.CreatedBy | String | The email address of the user who created the script. |
| CrowdStrike.Script.CreatedTime | Date | The datetime the script was created. |
| CrowdStrike.Script.Description | String | The description of the script. |
| CrowdStrike.Script.ModifiedBy | String | The email address of the user who modified the script. |
| CrowdStrike.Script.ModifiedTime | Date | The datetime the script was modified. |
| CrowdStrike.Script.Name | String | The script name. |
| CrowdStrike.Script.Permission | String | Permission type of the script. Possible values are: “private”, which is used only by the user who uploaded it, “group”, which is used by all RTR Admins, and “public”, which is used by all active-responders and RTR admins. |
| CrowdStrike.Script.SHA256 | String | The SHA-256 hash of the script file. |
| CrowdStrike.Script.RunAttemptCount | Number | The number of times the script attempted to run. |
| CrowdStrike.Script.RunSuccessCount | Number | The number of times the script ran successfully. |
| CrowdStrike.Script.Platform | String | The list of operating system platforms on which the script can run. For example, Windows. |
| CrowdStrike.Script.WriteAccess | Boolean | Whether the user has write access to the script. |
Command Example
!cs-falcon-get-script file_id=le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Context Example
{
"CrowdStrike": {
"Script": [
{
"CreatedBy": "spongobob@demisto.com",
"CreatedTime": "2019-10-17T13:41:48.487520845Z",
"Description": "Demisto",
"ID": "le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "spongobob@demisto.com",
"ModifiedTime": "2019-10-17T13:41:48.487521161Z",
"Name": "Demisto",
"Permission": "private",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"RunAttemptCount": 0,
"RunSuccessCount": 0,
"WriteAccess": true
}
]
}
}
Human Readable Output
CrowdStrike Falcon script le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
CreatedBy CreatedTime Description ID ModifiedBy ModifiedTime Name Permission SHA256 spongobob@demisto.com 2019-10-17T13:41:48.487520845Z Demisto le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 spongobob@demisto.com 2019-10-17T13:41:48.487521161Z Demisto private a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
cs-falcon-delete-script
Deletes a custom-script based on the provided ID. Can delete only one script at a time.
Base Command
cs-falcon-delete-script
Input
| Argument Name | Description | Required |
|---|---|---|
| script_id | The script ID to delete. The script IDs can be retrieved by running the ‘cs-falcon-list-scripts’ command. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-delete-script script_id=le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Human Readable Output
Script le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 was deleted successfully.
Context Output
There is no context output for this command.
cs-falcon-list-scripts
Returns a list of custom script IDs that are available for the user in the ‘runscript’ command.
Base Command
cs-falcon-list-scripts
Input
| Argument Name | Description | Required |
| — | — | — |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Script.ID | String | The ID of the script. |
| CrowdStrike.Script.CreatedBy | String | The email address of the user who created the script. |
| CrowdStrike.Script.CreatedTime | Date | The datetime the script was created. |
| CrowdStrike.Script.Description | String | The description of the script. |
| CrowdStrike.Script.ModifiedBy | String | The email address of the user who modified the script. |
| CrowdStrike.Script.ModifiedTime | Date | The datetime the script was modified. |
| CrowdStrike.Script.Name | String | The script name. |
| CrowdStrike.Script.Permission | String | Permission type of the script. Possible values are: “private”, which is used only by the user who uploaded it, “group”, which is used by all RTR Admins, and “public”, which is used by all active-responders and RTR admins. |
| CrowdStrike.Script.SHA256 | String | The SHA-256 hash of the script file. |
| CrowdStrike.Script.RunAttemptCount | Number | The number of times the script attempted to run. |
| CrowdStrike.Script.RunSuccessCount | Number | The number of times the script ran successfully. |
| CrowdStrike.Script.Platform | String | The list of operating system platforms on which the script can run. For example, Windows. |
| CrowdStrike.Script.WriteAccess | Boolean | Whether the user has write access to the script. |
Command Example
!cs-falcon-list-scripts
Context Example
{
"CrowdStrike": {
"Script": [
{
"CreatedBy": "spongobob@demisto.com",
"CreatedTime": "2019-10-17T13:41:48.487520845Z",
"Description": "Demisto",
"ID": "le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "spongobob@demisto.com",
"ModifiedTime": "2019-10-17T13:41:48.487521161Z",
"Name": "Demisto",
"Permission": "private",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"RunAttemptCount": 0,
"RunSuccessCount": 0,
"WriteAccess": true
}
]
}
}
Human Readable Output
CrowdStrike Falcon scripts
CreatedBy CreatedTime Description ID ModifiedBy ModifiedTime Name Permission SHA256 spongobob@demisto.com 2019-10-17T13:41:48.487520845Z Demisto le10098bf0e311e989190662caec3daa_a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 spongobob@demisto.com 2019-10-17T13:41:48.487521161Z Demisto private a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
cs-falcon-run-script
Runs a script on the agent host.
Base Command
cs-falcon-run-script
Input
| Argument Name | Description | Required |
|---|---|---|
| script_name | The name of the script to run. | Optional |
| host_ids | A comma-separated list of host agent IDs to run commands. The list of host agent IDs can be retrieved by running the ‘cs-falcon-search-device’ command. | Required |
| raw | The PowerShell script code to run. | Optional |
| timeout | Timeout for how long to wait for the request in seconds. Maximum is 600 (10 minutes). Default is 30. | Optional |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.HostID | String | The ID of the host for which the command was running. |
| CrowdStrike.Command.SessionID | String | The ID of the session of the host. |
| CrowdStrike.Command.Stdout | String | The standard output of the command. |
| CrowdStrike.Command.Stderr | String | The standard error of the command. |
| CrowdStrike.Command.BaseCommand | String | The base command. |
| CrowdStrike.Command.FullCommand | String | The full command. |
Command Example
cs-falcon-run-script host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 raw="Write-Output 'Hello, World!'"
Context Example
{
"CrowdStrike": {
"Command": [
{
"HostID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Stdout": "Hello, World!",
"Stderr": "",
"BaseCommand": "runscript",
"Command": "runscript -Raw=Write-Output 'Hello, World!'"
}
]
}
}
Human Readable Output
Command runscript -Raw=Write-Output ‘Hello, World! results
BaseCommand Command HostID Stderr Stdout runscript runscript -Raw=Write-Output ‘Hello, World! a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 Hello, World! Type Size (bytes) Size (MB) Last Modified (UTC-5) Created (UTC-5)
—- —- ———— ——— ——————— —————
$Recycle.Bin <Directory> – – 11/27/2018 10:54:44 AM 9/15/2017 3:33:40 AM
ITAYDI <Directory> – – 11/19/2018 1:31:42 PM 11/19/2018 1:31:42 PM
cs-falcon-run-get-command
Batch executes ‘get’ command across hosts to retrieve files.
Base Command
cs-falcon-run-get-command
Input
| Argument Name | Description | Required |
|---|---|---|
| host_ids | A comma-separated list of host agent IDs on which to run the RTR command. | Required |
| file_path | Full path to the file that will be retrieved from each host in the batch. | Required |
| optional_hosts | A comma-separated list of a subset of hosts on which to run the command. | Optional |
| timeout | The number of seconds to wait for the request before it times out. In ISO time format. For example: 2019-10-17T13:41:48.487520845Z. | Optional |
| timeout_duration | The amount of time to wait for the request before it times out. In duration syntax. For example, 10s. Valid units are: ns, us, ms, s, m, h. Maximum value is 10 minutes. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.HostID | string | The ID of the host on which the command was running. |
| CrowdStrike.Command.Stdout | string | The standard output of the command. |
| CrowdStrike.Command.Stderr | string | The standard error of the command. |
| CrowdStrike.Command.BaseCommand | string | The base command. |
| CrowdStrike.Command.TaskID | string | The ID of the command that was running on the host. |
| CrowdStrike.Command.GetRequestID | string | The ID of the command request that was accepted. |
| CrowdStrike.Command.Complete | boolean | True if the command completed. |
| CrowdStrike.Command.FilePath | string | The file path. |
Command Example
cs-falcon-run-get-command host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 file_path="""c:\Windows\notepad.exe"""
Context Example
{
"CrowdStrike": {
"Command": [
{
"BaseCommand": "get",
"Complete": true,
"FilePath": "c:\\Windows\\notepad.exe",
"GetRequestID": "84ee4d50-f499-482e-bac6-b0e296149bbf",
"HostID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Stderr": "",
"Stdout": "C:\\Windows\\notepad.exe",
"TaskID": "b5c8f140-280b-43fd-8501-9900f837510b"
}
]
}
}
Human Readable Output
Get command has requested for a file c:\Windows\notepad.exe
BaseCommand Complete FilePath GetRequestID HostID Stderr Stdout TaskID get true c:\Windows\notepad.exe 107199bc-544c-4b0c-8f20-3094c062a115 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 C:\Windows\notepad.exe 9c820b97-6a60-4238-bc23-f63513970ec8
cs-falcon-status-get-command
Retrieves the status of the specified batch ‘get’ command.
Base Command
cs-falcon-status-get-command
Input
| Argument Name | Description | Required |
|---|---|---|
| request_ids | A comma-separated list of IDs of the command requested. | Required |
| timeout | The number of seconds to wait for the request before it times out. In ISO time format. For example: 2019-10-17T13:41:48.487520845Z. | Optional |
| timeout_duration | The amount of time to wait for the request before it times out. In duration syntax. For example, 10s. Valid units are: ns, us, ms, s, m, h. Maximum value is 10 minutes. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.File.ID | string | The ID of the file. |
| CrowdStrike.File.TaskID | string | The ID of the command that is running. |
| CrowdStrike.File.CreatedAt | date | The date the file was created. |
| CrowdStrike.File.DeletedAt | date | The date the file was deleted. |
| CrowdStrike.File.UpdatedAt | date | The date the file was last updated. |
| CrowdStrike.File.Name | string | The full name of the file. |
| CrowdStrike.File.SHA256 | string | The SHA256 hash of the file. |
| CrowdStrike.File.Size | number | The size of the file in bytes. |
| File.Name | string | The full name of the file. |
| File.Size | number | The size of the file in bytes. |
| File.SHA256 | string | The SHA256 hash of the file. |
Command Example
!cs-falcon-status-get-command request_ids="84ee4d50-f499-482e-bac6-b0e296149bbf"
Context Example
{
"CrowdStrike": {
"File": {
"CreatedAt": "2020-05-01T16:09:00Z",
"DeletedAt": null,
"ID": 185596,
"Name": "\\Device\\HarddiskVolume2\\Windows\\notepad.exe",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Size": 0,
"TaskID": "b5c8f140-280b-43fd-8501-9900f837510b",
"UpdatedAt": "2020-05-01T16:09:00Z"
}
},
"File": {
"Name": "\\Device\\HarddiskVolume2\\Windows\\notepad.exe",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Size": 0
}
}
Human Readable Output
CrowdStrike Falcon files
CreatedAt DeletedAt ID Name SHA256 Size TaskID UpdatedAt 2020-05-01T16:09:00Z 185596 \Device\HarddiskVolume2\Windows\notepad.exe a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 0 b5c8f140-280b-43fd-8501-9900f837510b 2020-05-01T16:09:00Z
cs-falcon-status-command
Gets the status of a command executed on a host.
Base Command
cs-falcon-status-command
Input
| Argument Name | Description | Required |
|---|---|---|
| request_id | The ID of the command requested. | Required |
| sequence_id | The sequence ID in chunk requests. | Optional |
| scope | The scope to run the command for. Possible values are: read, write, admin. Default is read. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.TaskID | string | The ID of the command request that was accepted. |
| CrowdStrike.Command.Stdout | string | The standard output of the command. |
| CrowdStrike.Command.Stderr | string | The standard error of the command. |
| CrowdStrike.Command.BaseCommand | string | The base command. |
| CrowdStrike.Command.Complete | boolean | True if the command completed. |
| CrowdStrike.Command.SequenceID | number | The sequence ID in the current request. |
| CrowdStrike.Command.NextSequenceID | number | The sequence ID for the next request in the chunk request. |
Command Example
!cs-falcon-status-command request_id="ae323961-5aa8-442e-8461-8d05c4541d7d"
Context Example
{
"CrowdStrike": {
"Command": [
{
"BaseCommand": "ls",
"Complete": true,
"NextSequenceID": null,
"SequenceID": null,
"Stderr": "",
"Stdout": "Directory listing for C:\\ -\n\nName Type Size (bytes) Size (MB) Last Modified (UTC+9) Created (UTC+9) \n---- ---- ------------ --------- --------------------- --------------- \n$Recycle.Bin \u003cDirectory\u003e -- -- 2020/01/10 16:05:59 2019/03/19 13:52:43 \nConfig.Msi \u003cDirectory\u003e -- -- 2020/05/01 23:12:50 2020/01/10 16:52:09 \nDocuments and Settings \u003cDirectory\u003e -- -- 2019/09/12 15:03:21 2019/09/12 15:03:21 \nPerfLogs \u003cDirectory\u003e -- -- 2019/03/19 13:52:43 2019/03/19 13:52:43 \nProgram Files \u003cDirectory\u003e -- -- 2020/01/10 17:11:47 2019/03/19 13:52:43 \nProgram Files (x86) \u003cDirectory\u003e -- -- 2020/05/01 23:12:53 2019/03/19 13:52:44 \nProgramData \u003cDirectory\u003e -- -- 2020/01/10 17:16:51 2019/03/19 13:52:44 \nRecovery \u003cDirectory\u003e -- -- 2019/09/11 20:13:59 2019/09/11 20:13:59 \nSystem Volume Information \u003cDirectory\u003e -- -- 2019/09/12 15:08:21 2019/09/11 20:08:43 \nUsers \u003cDirectory\u003e -- -- 2019/09/22 22:26:11 2019/03/19 13:37:22 \nWindows \u003cDirectory\u003e -- -- 2020/05/01 23:09:08 2019/03/19 13:37:22 \npagefile.sys .sys 2334928896 2226.762 2020/05/02 2:10:05 2019/09/11 20:08:44 \nswapfile.sys .sys 268435456 256 2020/05/01 23:09:13 2019/09/11 20:08:44 \n",
"TaskID": "ae323961-5aa8-442e-8461-8d05c4541d7d"
}
]
}
}
Human Readable Output
Command status results
BaseCommand Complete Stdout TaskID ls true Directory listing for C:\ …… ae323961-5aa8-442e-8461-8d05c4541d7d
cs-falcon-get-extracted-file
Gets the RTR extracted file contents for the specified session and SHA256 hash.
Base Command
cs-falcon-get-extracted-file
Input
| Argument Name | Description | Required |
|---|---|---|
| host_id | The host agent ID. | Required |
| sha256 | The SHA256 hash of the file. | Required |
| filename | The filename to use for the archive name and the file within the archive. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-get-extracted-file host_id="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1" sha256="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
Context Output
There is no context output for this command.
cs-falcon-list-host-files
Gets a list of files for the specified RTR session on a host.
Base Command
cs-falcon-list-host-files
Input
| Argument Name | Description | Required |
|---|---|---|
| host_id | The ID of the host agent that lists files in the session. | Required |
| session_id | The ID of the existing session with the agent. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.HostID | string | The ID of the host the command was running for. |
| CrowdStrike.Command.TaskID | string | The ID of the command request that was accepted. |
| CrowdStrike.Command.SessionID | string | The ID of the session of the host. |
| CrowdStrike.File.ID | string | The ID of the file. |
| CrowdStrike.File.CreatedAt | date | The date the file was created. |
| CrowdStrike.File.DeletedAt | date | The date the file was deleted. |
| CrowdStrike.File.UpdatedAt | date | The date the file was last updated. |
| CrowdStrike.File.Name | string | The full name of the file. |
| CrowdStrike.File.SHA256 | string | The SHA256 hash of the file. |
| CrowdStrike.File.Size | number | The size of the file in bytes. |
| File.Name | string | The full name of the file. |
| File.Size | number | The size of the file in bytes. |
| File.SHA256 | string | The SHA256 hash of the file. |
Command Example
!cs-falcon-list-host-files host_id="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
Context Example
{
"CrowdStrike": {
"Command": {
"HostID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SessionID": "fdd6408f-6688-441b-8659-41bcad25441c",
"TaskID": "1269ad9e-c11f-4e38-8aba-1a0275304f9c"
},
"File": {
"CreatedAt": "2020-05-01T17:57:42Z",
"DeletedAt": null,
"ID": 186811,
"Name": "\\Device\\HarddiskVolume2\\Windows\\notepad.exe",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Size": 0,
"Stderr": null,
"Stdout": null,
"UpdatedAt": "2020-05-01T17:57:42Z"
}
},
"File": {
"Name": "\\Device\\HarddiskVolume2\\Windows\\notepad.exe",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Size": 0
}
}
Human Readable Output
CrowdStrike Falcon files
CreatedAt DeletedAt ID Name SHA256 Size Stderr Stdout UpdatedAt 2020-05-01T17:57:42Z 186811 \Device\HarddiskVolume2\Windows\notepad.exe a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 0 2020-05-01T17:57:42Z
cs-falcon-refresh-session
Refresh a session timeout on a single host.
Base Command
cs-falcon-refresh-session
Input
| Argument Name | Description | Required |
|---|---|---|
| host_id | The ID of the host to extend the session for. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-refresh-session host_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Human Readable Output
CrowdStrike Session Refreshed: fdd6408f-6688-441b-8659-41bcad25441c
Context Output
There is no context output for this command.
cs-falcon-search-custom-iocs
Returns a list of your uploaded IOCs that match the search criteria.
Base Command
cs-falcon-search-custom-iocs
Input
| Argument Name | Description | Required |
|---|---|---|
| types | A comma-separated list of indicator types. Possible values are: sha256, sha1, md5, domain, ipv4, ipv6. | Optional |
| values | A comma-separated list of indicator values. | Optional |
| sources | A comma-separated list of IOC sources. | Optional |
| expiration | The datetime the indicator will become inactive (ISO 8601 format, i.e., YYYY-MM-DDThh:mm:ssZ). | Optional |
| limit | The maximum number of records to return. The minimum is 1 and the maximum is 500. Default is 50. | Optional |
| sort | The order the results are returned in. Possible values are: type.asc, type.desc, value.asc, value.desc, policy.asc, policy.desc, share_level.asc, share_level.desc, expiration_timestamp.asc, expiration_timestamp.desc. | Optional |
| offset | The offset to begin the list from. For example, start from the 10th record and return the list. | Optional |
| next_page_token | A pagination token used with the limit parameter to manage pagination of results. Matching the ‘after’ parameter in the API. Use instead of offset. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator. |
| CrowdStrike.IOC.Severity | string | The severity level to apply to this indicator. |
| CrowdStrike.IOC.Source | string | The source of the IOC. |
| CrowdStrike.IOC.Action | string | Action to take when a host observes the custom IOC. |
| CrowdStrike.IOC.Expiration | string | The datetime the indicator will expire. |
| CrowdStrike.IOC.Description | string | The description of the IOC. |
| CrowdStrike.IOC.CreatedTime | date | The datetime the IOC was created. |
| CrowdStrike.IOC.CreatedBy | string | The identity of the user/process who created the IOC. |
| CrowdStrike.IOC.ModifiedTime | date | The datetime the indicator was last modified. |
| CrowdStrike.IOC.ModifiedBy | string | The identity of the user/process who last updated the IOC. |
| CrowdStrike.IOC.MobileAction | string | The action to take on mobile devices when a host observes the custom IOC. |
| CrowdStrike.NextPageToken | unknown | A pagination token used with the limit parameter to manage pagination of results. |
Command Example
!cs-falcon-search-custom-iocs limit=2
Context Example
{
"CrowdStrike": {
"IOC": [
{
"Action": "no_action",
"CreatedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"CreatedTime": "2022-02-16T17:17:25.992164453Z",
"Description": "test",
"Expiration": "2022-02-17T13:47:57Z",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedTime": "2022-02-16T17:17:25.992164453Z",
"Platforms": [
"mac"
],
"Severity": "informational",
"Source": "Cortex",
"Type": "ipv4",
"Value": "1.1.8.9"
},
{
"Action": "no_action",
"CreatedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"CreatedTime": "2022-02-16T17:16:44.514398876Z",
"Description": "test",
"Expiration": "2022-02-17T13:47:57Z",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedTime": "2022-02-16T17:16:44.514398876Z",
"Platforms": [
"mac"
],
"Severity": "informational",
"Source": "Cortex",
"Type": "ipv4",
"Value": "4.1.8.9"
}
]
}
}
Human Readable Output
Indicators of Compromise
ID Action Severity Type Value Expiration CreatedBy CreatedTime Description ModifiedBy ModifiedTime Platforms Policy ShareLevel Source Tags a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 no_action informational ipv4 1.1.8.9 2022-02-17T13:47:57Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T17:17:25.992164453Z test a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T17:17:25.992164453Z mac Cortex a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 no_action informational ipv4 4.1.8.9 2022-02-17T13:47:57Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T17:16:44.514398876Z test a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T17:16:44.514398876Z mac Cortex
cs-falcon-get-custom-ioc
Gets the full definition of one or more indicators that you are watching.
Base Command
cs-falcon-get-custom-ioc
Input
| Argument Name | Description | Required |
|---|---|---|
| type | The IOC type to retrieve. Either ioc_id or ioc_type and value must be provided. Possible values are: sha256, sha1, md5, domain, ipv4, ipv6. | Optional |
| value | The string representation of the indicator. Either ioc_id or ioc_type and value must be provided. | Optional |
| ioc_id | The ID of the IOC to get. The ID of the IOC can be retrieved by running the ‘cs-falcon-search-custom-iocs’ command. Either ioc_id or ioc_type and value must be provided. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator. |
| CrowdStrike.IOC.Severity | string | The severity level to apply to this indicator. |
| CrowdStrike.IOC.Source | string | The source of the IOC. |
| CrowdStrike.IOC.Action | string | Action to take when a host observes the custom IOC. |
| CrowdStrike.IOC.Expiration | string | The datetime when the indicator will expire. |
| CrowdStrike.IOC.Description | string | The description of the IOC. |
| CrowdStrike.IOC.CreatedTime | date | The datetime the IOC was created. |
| CrowdStrike.IOC.CreatedBy | string | The identity of the user/process who created the IOC. |
| CrowdStrike.IOC.ModifiedTime | date | The datetime the indicator was last modified. |
| CrowdStrike.IOC.ModifiedBy | string | The identity of the user/process who last updated the IOC. |
| CrowdStrike.IOC.MobileAction | string | The action to take on mobile devices when a host observes the custom IOC. |
Command Example
!cs-falcon-get-custom-ioc type=ipv4 value=7.5.9.8
Context Example
{
"CrowdStrike": {
"IOC": {
"Action": "no_action",
"MobileAction": "no_action",
"CreatedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"CreatedTime": "2022-02-16T14:25:22.968603813Z",
"Expiration": "2022-02-17T17:55:09Z",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedTime": "2022-02-16T14:25:22.968603813Z",
"Platforms": [
"linux"
],
"Severity": "informational",
"Source": "Cortex",
"Tags": [
"test",
"test1"
],
"Type": "ipv4",
"Value": "7.5.9.8"
}
}
}
Human Readable Output
Indicator of Compromise
ID Action Severity Type Value Expiration CreatedBy CreatedTime Description ModifiedBy ModifiedTime Platforms Policy ShareLevel Source Tags a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 no_action informational ipv4 7.5.9.8 2022-02-17T17:55:09Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T14:25:22.968603813Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T14:25:22.968603813Z linux Cortex test,
test1
cs-falcon-upload-custom-ioc
Uploads an indicator for CrowdStrike to monitor.
Base Command
cs-falcon-upload-custom-ioc
Input
| Argument Name | Description | Required |
|---|---|---|
| ioc_type | The type of the indicator. Possible values are: sha256, md5, domain, ipv4, ipv6. | Required |
| value | A comma-separated list of indicators. More than one value can be supplied to upload multiple IOCs of the same type but with different values. Note that the uploaded IOCs will have the same properties (as supplied in other arguments). |
Required |
| action | Action to take when a host observes the custom IOC. Possible values are: no_action - Save the indicator for future use, but take no action. No severity required. allow - Applies to hashes only. Allow the indicator and do not detect it. Severity does not apply and should not be provided. prevent_no_ui - Applies to hashes only. Block and detect the indicator, but hide it from Activity > Detections. Has a default severity value. prevent - Applies to hashes only. Block the indicator and show it as a detection at the selected severity. detect - Enable detections for the indicator at the selected severity. Possible values are: no_action, allow, prevent_no_ui, prevent, detect. | Required |
| platforms | A comma-separated list of the platforms that the indicator applies to. Possible values are: mac, windows, linux, android, ios. | Required |
| severity | The severity level to apply to this indicator. Required for the prevent and detect actions. Optional for no_action. Possible values are: informational, low, medium, high, critical. | Optional |
| expiration | The datetime the indicator will become inactive (ISO 8601 format, i.e., YYYY-MM-DDThh:mm:ssZ). | Optional |
| source | The source where this indicator originated. This can be used for tracking where this indicator was defined. Limited to 200 characters. | Optional |
| description | A meaningful description of the indicator. Limited to 200 characters. | Optional |
| applied_globally | Whether the indicator is applied globally. Either applied_globally or host_groups must be provided. Possible values are: true, false. | Optional |
| host_groups | A comma-separated list of host group IDs that the indicator applies to. The list of host group IDs can be retrieved by running the ‘cs-falcon-list-host-groups’ command. Either applied_globally or host_groups must be provided. | Optional |
| tags | A comma-separated list of tags to apply to the indicator. | Optional |
| file_name | Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. | Optional |
| mobile_action | The action to take on mobile devices when a host observes the custom IOC. Note: To use this argument, a mobile platform (android or ios) must be included in the platforms argument. - no_action: The indicator is saved for future use, but no action is taken (no severity required). - allow: The indicator is allowed and not detected (severity does not apply and should not be provided). - detect: The connection is allowed and a detection is generated. - prevent: The indicator is blocked and shown as a detection. Possible values are: no_action, allow, detect, prevent. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator. |
| CrowdStrike.IOC.Severity | string | The severity level to apply to this indicator. |
| CrowdStrike.IOC.Source | string | The source of the IOC. |
| CrowdStrike.IOC.Action | string | Action to take when a host observes the custom IOC. |
| CrowdStrike.IOC.Expiration | string | The datetime when the indicator will expire. |
| CrowdStrike.IOC.Description | string | The description of the IOC. |
| CrowdStrike.IOC.CreatedTime | date | The datetime the IOC was created. |
| CrowdStrike.IOC.CreatedBy | string | The identity of the user/process who created the IOC. |
| CrowdStrike.IOC.ModifiedTime | date | The datetime the indicator was last modified. |
| CrowdStrike.IOC.ModifiedBy | string | The identity of the user/process who last updated the IOC. |
| CrowdStrike.IOC.Tags | Unknown | The tags of the IOC. |
| CrowdStrike.IOC.Platforms | Unknown | The platforms of the IOC. |
| CrowdStrike.IOC.Filename | string | Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. |
| CrowdStrike.IOC.MobileAction | string | The action to take on mobile devices when a host observes the custom IOC. |
Command Example
!cs-falcon-upload-custom-ioc ioc_type="domain" value="test.domain.com" action="prevent" severity="high" source="Demisto playbook" description="Test ioc" platforms="mac" mobile_action="no_action"
Context Example
{
"CrowdStrike": {
"IOC": {
"CreatedTime": "2020-10-02T13:55:26Z",
"Description": "Test ioc",
"Expiration": "2020-11-01T00:00:00Z",
"ID": "4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r",
"ModifiedTime": "2020-10-02T13:55:26Z",
"Action": "prevent",
"MobileAction": "no_action",
"Severity": "high",
"Source": "Demisto playbook",
"Type": "domain",
"Value": "test.domain.com",
"Platforms": ["mac"]
}
}
}
Human Readable Output
Custom IOC was created successfully
CreatedTime Description Expiration ID ModifiedTime Action Severity Source Type Value 2020-10-02T13:55:26Z Test ioc 2020-11-01T00:00:00Z 4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r 2020-10-02T13:55:26Z prevent high Demisto playbook domain test.domain.com
cs-falcon-update-custom-ioc
Updates an indicator for CrowdStrike to monitor.
Base Command
cs-falcon-update-custom-ioc
Input
| Argument Name | Description | Required |
|---|---|---|
| ioc_id | The ID of the IOC to update. The ID of the IOC can be retrieved by running the ‘cs-falcon-search-custom-iocs’ command. | Required |
| action | Action to take when a host observes the custom IOC. Possible values are: no_action - Save the indicator for future use, but take no action. No severity required. allow - Applies to hashes only. Allow the indicator and do not detect it. Severity does not apply and should not be provided. prevent_no_ui - Applies to hashes only. Block and detect the indicator, but hide it from Activity > Detections. Has a default severity value. prevent - Applies to hashes only. Block the indicator and show it as a detection at the selected severity. detect - Enable detections for the indicator at the selected severity. Possible values are: no_action, allow, prevent_no_ui, prevent, detect. | Optional |
| platforms | A comma-separated list of the platforms that the indicator applies to. Possible values are: mac, windows, linux. | Optional |
| severity | The severity level to apply to this indicator. Required for the prevent and detect actions. Optional for no_action. Possible values are: informational, low, medium, high, critical. | Optional |
| expiration | The datetime the indicator will become inactive (ISO 8601 format, i.e., YYYY-MM-DDThh:mm:ssZ). | Optional |
| source | The source where this indicator originated. This can be used for tracking where this indicator was defined. Limited to 200 characters. | Optional |
| description | A meaningful description of the indicator. Limited to 200 characters. | Optional |
| file_name | Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. | Optional |
| mobile_action | The action to take on mobile devices when a host observes the custom IOC. Note: To use this argument, a mobile platform (android or ios) must be included in the platforms argument. - no_action: The indicator is saved for future use, but no action is taken (no severity required). - allow: The indicator is allowed and not detected (severity does not apply and should not be provided). - detect: The connection is allowed and a detection is generated. - prevent: The indicator is blocked and shown as a detection. Possible values are: no_action, allow, detect, prevent. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator. |
| CrowdStrike.IOC.Severity | string | The severity level to apply to this indicator. |
| CrowdStrike.IOC.Source | string | The source of the IOC. |
| CrowdStrike.IOC.Action | string | Action to take when a host observes the custom IOC. |
| CrowdStrike.IOC.Expiration | string | The datetime when the indicator will expire. |
| CrowdStrike.IOC.Description | string | The description of the IOC. |
| CrowdStrike.IOC.CreatedTime | date | The datetime the IOC was created. |
| CrowdStrike.IOC.CreatedBy | string | The identity of the user/process who created the IOC. |
| CrowdStrike.IOC.ModifiedTime | date | The datetime the indicator was last modified. |
| CrowdStrike.IOC.ModifiedBy | string | The identity of the user/process who last updated the IOC. |
| CrowdStrike.IOC.Filename | string | Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. |
| CrowdStrike.IOC.MobileAction | string | The action to take on mobile devices when a host observes the custom IOC. |
Command Example
!cs-falcon-update-custom-ioc ioc_id="4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r" severity="high"
Context Example
{
"CrowdStrike": {
"IOC": {
"CreatedTime": "2020-10-02T13:55:26Z",
"Description": "Test ioc",
"Expiration": "2020-11-01T00:00:00Z",
"ID": "4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r",
"ModifiedTime": "2020-10-02T13:55:26Z",
"Action": "prevent",
"MobileAction": "no_action",
"Severity": "high",
"Source": "Demisto playbook",
"Type": "domain",
"Value": "test.domain.com"
}
}
}
Human Readable Output
Custom IOC was updated successfully
CreatedTime Description Expiration ID ModifiedTime Action Severity Source Type Value 2020-10-02T13:55:26Z Test ioc 2020-11-01T00:00:00Z 4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r 2020-10-02T13:55:26Z prevent high Demisto playbook domain test.domain.com
cs-falcon-delete-custom-ioc
Deletes a monitored indicator.
Base Command
cs-falcon-delete-custom-ioc
Input
| Argument Name | Description | Required |
|---|---|---|
| ioc_id | The ID of the IOC to delete. The ID of the IOC can be retrieved by running the ‘cs-falcon-search-custom-iocs’ command. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-delete-custom-ioc ioc_id="4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r"
Human Readable Output
Custom IOC 4f8c43311k1801ca4359fc07t319610482c2003mcde8934d5412b1781e841e9r was successfully deleted.
cs-falcon-device-count-ioc
The number of hosts that observed the provided IOC.
Base Command
cs-falcon-device-count-ioc
Input
| Argument Name | Description | Required |
|---|---|---|
| type | The IOC type. Possible values are: sha256, sha1, md5, domain, ipv4, ipv6. | Required |
| value | The string representation of the indicator. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator (type:value). |
| CrowdStrike.IOC.DeviceCount | number | The number of devices the IOC ran on. |
Command Example
!cs-falcon-device-count-ioc type="domain" value="value"
Context Example
{
"CrowdStrike": {
"IOC": {
"DeviceCount": 1,
"ID": "domain:value",
"Type": "domain",
"Value": "value"
}
}
}
Human Readable Output
Indicator of Compromise domain:value device count: 1
cs-falcon-processes-ran-on
Get processes associated with a given IOC.
Base Command
cs-falcon-processes-ran-on
Input
| Argument Name | Description | Required |
|---|---|---|
| type | The IOC type. Possible values are: sha256, sha1, md5, domain, ipv4, ipv6. | Required |
| value | The string representation of the indicator. | Required |
| device_id | The device ID to check against. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator (type:value). |
| CrowdStrike.IOC.Process.ID | number | The processes IDs associated with the given IOC. |
| CrowdStrike.IOC.Process.DeviceID | number | The device the process ran on. |
Command Example
!cs-falcon-processes-ran-on device_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 type=domain value=value
Context Example
{
"CrowdStrike": {
"IOC": {
"ID": "domain:value",
"Process": {
"DeviceID": "pid",
"ID": [
"pid:pid:650164094720"
]
},
"Type": "domain",
"Value": "value"
}
}
}
Human Readable Output
Processes with custom IOC domain:value on device device_id
Process ID pid:pid:650164094720
cs-falcon-process-details
Retrieves the details of a process, according to the process ID that is running or that previously ran.
Base Command
cs-falcon-process-details
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of process IDs. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Process.process_id | String | The process ID. |
| CrowdStrike.Process.process_id_local | String | Local ID of the process. |
| CrowdStrike.Process.device_id | String | The device the process ran on. |
| CrowdStrike.Process.file_name | String | The path of the file that ran the process. |
| CrowdStrike.Process.command_line | String | The command line command execution. |
| CrowdStrike.Process.start_timestamp_raw | String | The start datetime of the process in Unix time format. For example: 132460167512852140. |
| CrowdStrike.Process.start_timestamp | String | The start datetime of the process in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.Process.stop_timestamp_raw | Date | The stop datetime of the process in Unix time format. For example: 132460167512852140. |
| CrowdStrike.Process.stop_timestamp | Date | The stop datetime of the process in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
Command Example
!cs-falcon-process-details ids="pid:pid:pid"
Context Example
{
"CrowdStrike": {
"Process": {
"command_line": "\"C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe\"",
"device_id": "deviceId",
"file_name": "\\Device\\HarddiskVolume1\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe",
"process_id": "deviceId:pid",
"process_id_local": "pid",
"start_timestamp": "2020-10-01T09:05:51Z",
"start_timestamp_raw": "132460167512852140",
"stop_timestamp": "2020-10-02T06:43:45Z",
"stop_timestamp_raw": "132460946259334768"
}
}
}
Human Readable Output
Details for process: pid:pid:pid
command_line device_id file_name process_id process_id_local start_timestamp start_timestamp_raw stop_timestamp stop_timestamp_raw “C:\Program Files (x86)\Google\Chrome\Application\chrome.exe” deviceId \Device\HarddiskVolume1\Program Files (x86)\Google\Chrome\Application\chrome.exe device_id:pid pid 2020-10-01T09:05:51Z 132460167512852140 2020-10-02T06:43:45Z 132460946259334768
cs-falcon-device-ran-on
Returns a list of device IDs an indicator ran on.
Base Command
cs-falcon-device-ran-on
Input
| Argument Name | Description | Required |
|---|---|---|
| type | The type of indicator. Possible values are: domain, ipv4, ipv6, md5, sha1, sha256. | Required |
| value | The string representation of the indicator. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.DeviceID | string | Device IDs an indicator ran on. |
Command Example
!cs-falcon-device-ran-on type=domain value=value
Context Example
{
"CrowdStrike": {
"DeviceID": [
"a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
]
}
}
Human Readable Output
Devices that encountered the IOC domain:value
Device ID a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
cs-falcon-list-detection-summaries
Lists detection summaries.
Base Command
cs-falcon-list-detection-summaries
Input
| Argument Name | Description | Required |
|---|---|---|
| fetch_query | The query used to filter the results. | Optional |
| ids | A comma-separated list of detection IDs. For example, ldt:1234:1234,ldt:5678:5678. If you use this argument, the fetch_query argument will be ignored. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Detections.cid | String | The organization’s customer ID (CID). |
| CrowdStrike.Detections.created_timestamp | Date | The datetime the detection occurred in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.Detections.detection_id | String | The ID of the detection. |
| CrowdStrike.Detections.device.device_id | String | The device ID as seen by CrowdStrike Falcon. |
| CrowdStrike.Detections.device.cid | String | The CrowdStrike Customer ID (CID) to which the device belongs. |
| CrowdStrike.Detections.device.agent_load_flags | String | The CrowdStrike Falcon agent load flags. |
| CrowdStrike.Detections.device.agent_local_time | Date | The local time of the sensor. |
| CrowdStrike.Detections.device.agent_version | String | The version of the agent that the device is running. For example: 5.32.11406.0. |
| CrowdStrike.Detections.device.bios_manufacturer | String | The BIOS manufacturer. |
| CrowdStrike.Detections.device.bios_version | String | The device’s BIOS version. |
| CrowdStrike.Detections.device.config_id_base | String | The base of the sensor that the device is running. |
| CrowdStrike.Detections.device.config_id_build | String | The version of the sensor that the device is running. For example: 11406. |
| CrowdStrike.Detections.device.config_id_platform | String | The platform ID of the sensor that the device is running. |
| CrowdStrike.Detections.device.external_ip | String | The external IP address of the device. |
| CrowdStrike.Detections.device.hostname | String | The hostname of the device. |
| CrowdStrike.Detections.device.first_seen | Date | The datetime the host was first seen by CrowdStrike Falcon. |
| CrowdStrike.Detections.device.last_seen | Date | The datetime the host was last seen by CrowdStrike Falcon. |
| CrowdStrike.Detections.device.local_ip | String | The local IP address of the device. |
| CrowdStrike.Detections.device.mac_address | String | The MAC address of the device. |
| CrowdStrike.Detections.device.major_version | String | The major version of the operating system. |
| CrowdStrike.Detections.device.minor_version | String | The minor version of the operating system. |
| CrowdStrike.Detections.device.os_version | String | The operating system of the device. |
| CrowdStrike.Detections.device.platform_id | String | The platform ID of the device that runs the sensor. |
| CrowdStrike.Detections.device.platform_name | String | The platform name of the device. |
| CrowdStrike.Detections.device.product_type_desc | String | The value indicating the product type. For example, 1 = Workstation, 2 = Domain Controller, 3 = Server. |
| CrowdStrike.Detections.device.status | String | The containment status of the machine. Possible values are: “normal”, “containment_pending”, “contained”, and “lift_containment_pending”. |
| CrowdStrike.Detections.device.system_manufacturer | String | The system manufacturer of the device. |
| CrowdStrike.Detections.device.system_product_name | String | The product name of the system. |
| CrowdStrike.Detections.device.modified_timestamp | Date | The datetime the device was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.Detections.behaviors.device_id | String | The ID of the device associated with the behavior. |
| CrowdStrike.Detections.behaviors.timestamp | Date | The datetime the behavior detection occurred in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.Detections.behaviors.filename | String | The filename of the triggering process. |
| CrowdStrike.Detections.behaviors.alleged_filetype | String | The file extension of the behavior’s filename. |
| CrowdStrike.Detections.behaviors.cmdline | String | The command line of the triggering process. |
| CrowdStrike.Detections.behaviors.scenario | String | The name of the scenario the behavior belongs to. |
| CrowdStrike.Detections.behaviors.objective | String | The name of the objective associated with the behavior. |
| CrowdStrike.Detections.behaviors.tactic | String | The name of the tactic associated with the behavior. |
| CrowdStrike.Detections.behaviors.technique | String | The name of the technique associated with the behavior. |
| CrowdStrike.Detections.behaviors.severity | Number | The severity rating for the behavior. The value can be any integer between 1-100. |
| CrowdStrike.Detections.behaviors.confidence | Number | The true positive confidence rating for the behavior. The value can be any integer between 1-100. |
| CrowdStrike.Detections.behaviors.ioc_type | String | The type of the triggering IOC. Possible values are: “hash_sha256”, “hash_md5”, “domain”, “filename”, “registry_key”, “command_line”, and “behavior”. |
| CrowdStrike.Detections.behaviors.ioc_value | String | The IOC value. |
| CrowdStrike.Detections.behaviors.user_name | String | The user name. |
| CrowdStrike.Detections.behaviors.user_id | String | The Security Identifier (SID) of the user in Windows. |
| CrowdStrike.Detections.behaviors.control_graph_id | String | The behavior hit key for the Threat Graph API. |
| CrowdStrike.Detections.behaviors.triggering_process_graph_id | String | The ID of the process that triggered the behavior detection. |
| CrowdStrike.Detections.behaviors.sha256 | String | The SHA256 of the triggering process. |
| CrowdStrike.Detections.behaviors.md5 | String | The MD5 hash of the triggering process. |
| CrowdStrike.Detections.behaviors.parent_details.parent_sha256 | String | The SHA256 hash of the parent process. |
| CrowdStrike.Detections.behaviors.parent_details.parent_md5 | String | The MD5 hash of the parent process. |
| CrowdStrike.Detections.behaviors.parent_details.parent_cmdline | String | The command line of the parent process. |
| CrowdStrike.Detections.behaviors.parent_details.parent_process_graph_id | String | The process graph ID of the parent process. |
| CrowdStrike.Detections.behaviors.pattern_disposition | Number | The pattern associated with the action performed on the behavior. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.indicator | Boolean | Whether the detection behavior is similar to an indicator. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.detect | Boolean | Whether this behavior is detected. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.inddet_mask | Boolean | Whether this behavior is an inddet mask. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.sensor_only | Boolean | Whether this detection is sensor only. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.rooting | Boolean | Whether this behavior is rooting. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.kill_process | Boolean | Whether this detection kills the process. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.kill_subprocess | Boolean | Whether this detection kills the subprocess. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.quarantine_machine | Boolean | Whether this detection was on a quarantined machine. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.quarantine_file | Boolean | Whether this detection was on a quarantined file. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.policy_disabled | Boolean | Whether this policy is disabled. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.kill_parent | Boolean | Whether this detection kills the parent process. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.operation_blocked | Boolean | Whether the operation is blocked. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.process_blocked | Boolean | Whether the process is blocked. |
| CrowdStrike.Detections.behaviors.pattern_disposition_details.registry_operation_blocked | Boolean | Whether the registry operation is blocked. |
| CrowdStrike.Detections.email_sent | Boolean | Whether an email is sent about this detection. |
| CrowdStrike.Detections.show_in_ui | Boolean | Whether the detection displays in the UI. |
| CrowdStrike.Detections.status | String | The status of the detection. |
| CrowdStrike.Detections.hostinfo.domain | String | The domain of the Active Directory. |
| CrowdStrike.Detections.seconds_to_triaged | Number | The amount of time it took to move a detection from “new” to “in_progress”. |
| CrowdStrike.Detections.seconds_to_resolved | Number | The amount of time it took to move a detection from new to a resolved state (“true_positive”, “false_positive”, and “ignored”). |
Command Example
#### Context Example
```json
{
"CrowdStrike": {
"Detections": [
{
"behaviors": [
{
"alleged_filetype": "exe",
"behavior_id": "10197",
"cmdline": "choice /m crowdstrike_sample_detection",
"confidence": 80,
"control_graph_id": "ctg:ctg:ctg",
"device_id": "deviceid",
"display_name": "",
"filename": "choice.exe",
"filepath": "",
"ioc_description": "",
"ioc_source": "",
"ioc_type": "",
"ioc_value": "",
"md5": "md5",
"objective": "Falcon Detection Method",
"parent_details": {
"parent_cmdline": "\"C:\\Windows\\system32\\cmd.exe\" ",
"parent_md5": "md5",
"parent_process_graph_id": "pid:pid:pid",
"parent_sha256": "sha256"
},
"pattern_disposition": 0,
"pattern_disposition_details": {
"bootup_safeguard_enabled": false,
"critical_process_disabled": false,
"detect": false,
"fs_operation_blocked": false,
"inddet_mask": false,
"indicator": false,
"kill_parent": false,
"kill_process": false,
"kill_subprocess": false,
"operation_blocked": false,
"policy_disabled": false,
"process_blocked": false,
"quarantine_file": false,
"quarantine_machine": false,
"registry_operation_blocked": false,
"rooting": false,
"sensor_only": false
},
"scenario": "suspicious_activity",
"severity": 30,
"sha256": "sha256",
"tactic": "Malware",
"tactic_id": "",
"technique": "Malicious File",
"technique_id": "",
"template_instance_id": "382",
"timestamp": "2020-07-06T08:10:44Z",
"triggering_process_graph_id": "pid:pid:pid",
"user_id": "user_id",
"user_name": "user_name"
}
],
"behaviors_processed": [
"pid:pid:pid:10197"
],
"cid": "cid",
"created_timestamp": "2020-07-06T08:10:55.538668036Z",
"detection_id": "ldt:ldt:ldt",
"device": {
"agent_load_flags": "0",
"agent_local_time": "2020-07-02T01:42:07.640Z",
"agent_version": "5.32.11406.0",
"bios_manufacturer": "Google",
"bios_version": "Google",
"cid": "cid",
"config_id_base": "id",
"config_id_build": "id",
"config_id_platform": "3",
"device_id": "device_id",
"external_ip": "external_ip",
"first_seen": "2020-02-10T12:40:18Z",
"hostname": "FALCON-CROWDSTR",
"last_seen": "2020-07-06T07:59:12Z",
"local_ip": "local_ip",
"mac_address": "mac_address",
"major_version": "major_version",
"minor_version": "minor_version",
"modified_timestamp": "modified_timestamp",
"os_version": "os_version",
"platform_id": "platform_id",
"platform_name": "platform_name",
"product_type": "product_type",
"product_type_desc": "product_type_desc",
"status": "status",
"system_manufacturer": "system_manufacturer",
"system_product_name": "system_product_name"
},
"email_sent": false,
"first_behavior": "2020-07-06T08:10:44Z",
"hostinfo": {
"domain": ""
},
"last_behavior": "2020-07-06T08:10:44Z",
"max_confidence": 80,
"max_severity": 30,
"max_severity_displayname": "Low",
"seconds_to_resolved": 0,
"seconds_to_triaged": 0,
"show_in_ui": true,
"status": "new"
}
]
}
}
Human Readable Output
CrowdStrike Detections
detection_id created_time status max_severity ldt:ldt:ldt 2020-07-06T08:10:55.538668036Z new Low
endpoint
Returns information about an endpoint. Does not support regex.
Base Command
endpoint
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The endpoint ID. | Optional |
| ip | The endpoint IP address. | Optional |
| hostname | The endpoint hostname. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| Endpoint.Hostname | String | The endpoint’s hostname. |
| Endpoint.OS | String | The endpoint’s operation system. |
| Endpoint.IPAddress | String | The endpoint’s IP address. |
| Endpoint.ID | String | The endpoint’s ID. |
| Endpoint.Status | String | The endpoint’s status. |
| Endpoint.IsIsolated | String | The endpoint’s isolation status. |
| Endpoint.MACAddress | String | The endpoint’s MAC address. |
| Endpoint.Vendor | String | The integration name of the endpoint vendor. |
| Endpoint.OSVersion | String | The endpoint’s operation system version. |
Command Example
!endpoint id=15dbb9d5fe9f61eb46e829d986
Context Example
{
"Endpoint":
{
"Hostname": "Hostname",
"ID": "15dbb9d5fe9f61eb46e829d986",
"IPAddress": "1.1.1.1",
"OS": "Windows",
"OSVersion": "Windows Server 2019",
"Status": "Online",
"Vendor": "CrowdStrike Falcon",
"MACAddress": "1-1-1-1"
}
}
Human Readable Output
Endpoints
ID IPAddress OS OSVersion Hostname Status MACAddress Vendor a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 1.1.1.1 Windows Windows Server 2019 Hostname Online 1-1-1-1 CrowdStrike Falcon \n”
cs-falcon-create-host-group
Create a host group.
Base Command
cs-falcon-create-host-group
Input
| Argument Name | Description | Required |
|---|---|---|
| name | The name of the host. | Required |
| group_type | The group type of the group. Possible values are: static, dynamic. | Required |
| description | The description of the host. | Optional |
| assignment_rule | The assignment rule. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.HostGroup.id | String | The ID of the host group. |
| CrowdStrike.HostGroup.group_type | String | The group type of the host group. |
| CrowdStrike.HostGroup.name | String | The name of the host group. |
| CrowdStrike.HostGroup.description | String | The description of the host group. |
| CrowdStrike.HostGroup.created_by | String | The client that created the host group. |
| CrowdStrike.HostGroup.created_timestamp | Date | The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.HostGroup.modified_by | String | The client that modified the host group. |
| CrowdStrike.HostGroup.modified_timestamp | Date | The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
Command Example
!cs-falcon-create-host-group name="test_name_1" description="test_description" group_type=static
Context Example
{
"CrowdStrike": {
"HostGroup": {
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-25T08:02:02.060242909Z",
"description": "test_description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-25T08:02:02.060242909Z",
"name": "test_name_1"
}
}
}
Human Readable Output
Results
created_by created_timestamp description group_type id modified_by modified_timestamp name api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-25T08:02:02.060242909Z test_description static a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-25T08:02:02.060242909Z test_name_1
cs-falcon-list-host-groups
List the available host groups.
Base Command
cs-falcon-list-host-groups
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | The query by which to filter the devices that belong to the host group. | Optional |
| offset | Page offset. | Optional |
| limit | Maximum number of results on a page. Default is 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.HostGroup.id | String | The ID of the host group. |
| CrowdStrike.HostGroup.group_type | String | The group type of the host group. |
| CrowdStrike.HostGroup.name | String | The name of the host group. |
| CrowdStrike.HostGroup.description | String | The description of the host group. |
| CrowdStrike.HostGroup.created_by | String | The client that created the host group. |
| CrowdStrike.HostGroup.created_timestamp | Date | The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.HostGroup.modified_by | String | The client that modified the host group. |
| CrowdStrike.HostGroup.modified_timestamp | Date | The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
Command Example
#### Context Example
```json
{
"CrowdStrike": {
"HostGroup": [
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:23.765624811Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:23.765624811Z",
"name": "InnerServicesModuleMon Aug 23 2021"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:25.506030441Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:25.506030441Z",
"name": "Rasterize_default_instanceMon Aug 23 2021"
},
{
"assignment_rule": "device_id:[''],hostname:['','FALCON-CROWDSTR']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-07-27T12:34:59.13917402Z",
"description": "",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-07-27T12:34:59.13917402Z",
"name": "Static by id group test"
},
{
"assignment_rule": "device_id:[],hostname:[]",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-07-27T12:24:18.364057533Z",
"description": "Group test",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-07-27T12:24:18.364057533Z",
"name": "Static group test"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:26.069515348Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:26.069515348Z",
"name": "ad-loginMon Aug 23 2021"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:25.556897468Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:25.556897468Z",
"name": "ad-queryMon Aug 23 2021"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:23.737307612Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:23.737307612Z",
"name": "d2Mon Aug 23 2021"
},
{
"created_by": "someone@email.com",
"created_timestamp": "2021-07-27T12:27:43.503021999Z",
"description": "dhfh",
"group_type": "staticByID",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "someone@email.com",
"modified_timestamp": "2021-07-27T12:27:43.503021999Z",
"name": "ddfxgh"
},
{
"assignment_rule": "device.hostname:'FALCON-CROWDSTR'",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-07-27T12:46:39.058352326Z",
"description": "",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-07-27T12:46:39.058352326Z",
"name": "dynamic 1 group test"
},
{
"assignment_rule": "lkjlk:'FalconGroupingTags/example_tag'",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T13:12:56.338590022Z",
"description": "",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T13:12:56.338590022Z",
"name": "dynamic 13523 group test"
},
{
"assignment_rule": "lkjlk:'FalconGroupingTags/example_tag'",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-07-27T14:02:05.538065349Z",
"description": "",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-07-27T14:02:05.538065349Z",
"name": "dynamic 1353 group test"
},
{
"assignment_rule": "tags:'FalconGroupingTags/example_tag'",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-07-27T12:41:33.127997409Z",
"description": "",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-07-27T12:41:33.127997409Z",
"name": "dynamic 2 group test"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:23.7402217Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:23.7402217Z",
"name": "fcm_default_instanceMon Aug 23 2021"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-11T09:55:23.801049103Z",
"description": "ilan test",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-11T09:55:23.801049103Z",
"name": "ilan"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-12T11:24:51.434863056Z",
"description": "ilan test",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-12T11:24:51.434863056Z",
"name": "ilan 2"
},
{
"assignment_rule": "device_id:[''],hostname:['FALCON-CROWDSTR']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-12T11:55:57.943490809Z",
"description": "ilan test",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-12T11:55:57.943490809Z",
"name": "ilan 23"
},
{
"assignment_rule": "",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-17T11:28:39.855075106Z",
"description": "after change",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T09:26:15.351650252Z",
"name": "ilan 2345"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-17T11:58:42.453661998Z",
"description": "ilan test",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-17T11:58:42.453661998Z",
"name": "ilan 23e"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-11T13:54:59.695821727Z",
"description": "",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-11T13:54:59.695821727Z",
"name": "ilan test 2"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-12T10:56:49.2127345Z",
"description": "ilan test",
"group_type": "dynamic",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-12T11:35:35.76509212Z",
"name": "ilan2"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T14:35:23.766284685Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T14:35:23.766284685Z",
"name": "splunkMon Aug 23 2021"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:09:15.36414377Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:09:15.36414377Z",
"name": "test_1629731353498"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:12:20.69203954Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:12:20.69203954Z",
"name": "test_1629731538458"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:14:20.650781714Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:14:23.026511269Z",
"name": "test_16297316587261629731658726"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:18:53.896505566Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:18:56.2598933Z",
"name": "test_16297319320381629731932038"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:19:51.91067257Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:19:54.269898808Z",
"name": "test_16297319902371629731990237"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:25:42.99601887Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:25:42.99601887Z",
"name": "test_1629732339973"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:26:12.280379354Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:26:14.973676462Z",
"name": "test_16297323698941629732369894"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:26:58.717706381Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:27:01.648623079Z",
"name": "test_16297324168771629732416877"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:28:18.674512647Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:28:21.781563212Z",
"name": "test_16297324965761629732496576"
},
{
"assignment_rule": "device_id:[''],hostname:['FALCON-CROWDSTR','INSTANCE-1','falcon-crowdstrike-sensor-centos7']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:31:41.142748214Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:31:43.800147323Z",
"name": "test_16297326990981629732699098"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:34:20.195778795Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:34:23.212828317Z",
"name": "test_16297328579781629732857978"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:34:55.837119719Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:34:58.490114093Z",
"name": "test_16297328938791629732893879"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-23T15:37:42.911344704Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-23T15:37:45.620464598Z",
"name": "test_16297330605301629733060530"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-24T07:05:55.813475476Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-24T07:05:58.805702883Z",
"name": "test_16297887501421629788750142"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-24T07:07:30.422517324Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-24T07:07:34.291988227Z",
"name": "test_16297888481381629788848138"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-24T08:03:15.522772079Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-24T08:03:18.622015517Z",
"name": "test_16297921932741629792193274"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:09:52.379925975Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:09:52.379925975Z",
"name": "test_1629967211800"
},
{
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T12:34:36.934507422Z",
"description": "description",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T12:34:36.934507422Z",
"name": "test_162996721180000"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T08:46:09.996065663Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T08:46:11.572092204Z",
"name": "test_16299675695531629967569553"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T08:53:15.35181954Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T08:53:17.041535905Z",
"name": "test_16299679949831629967994983"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T08:59:52.639696743Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T08:59:54.538170036Z",
"name": "test_16299683923121629968392312"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:06:21.891707157Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:06:23.846219163Z",
"name": "test_16299687814871629968781487"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:12:53.982989Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:12:55.571265187Z",
"name": "test_16299691732871629969173287"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:17:58.206157753Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:17:59.659515838Z",
"name": "test_16299694779051629969477905"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:19:23.276267291Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:19:25.318976241Z",
"name": "test_16299695623981629969562398"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:26:22.538367707Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:26:25.085214782Z",
"name": "test_16299699813871629969981387"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:33:46.303790983Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:33:48.288311235Z",
"name": "test_16299704254441629970425444"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T09:55:09.157561612Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T09:55:10.741852436Z",
"name": "test_16299717065381629971706538"
},
{
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-26T10:02:50.175530821Z",
"description": "description2",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-26T10:02:52.026307768Z",
"name": "test_16299721694081629972169408"
}
]
}
}
Human Readable Output
Results
assignment_rule created_by created_timestamp description group_type id modified_by modified_timestamp name device_id:[’’],hostname:[’’] api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-26T10:02:50.175530821Z description2 static a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-26T10:02:52.026307768Z test_16299721694081629972169408
cs-falcon-delete-host-groups
Deletes the requested host groups.
Base Command
cs-falcon-delete-host-groups
Input
| Argument Name | Description | Required |
|---|---|---|
| host_group_id | A comma-separated list of the IDs of the host groups to be deleted. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-delete-host-groups host_group_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1,a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Human Readable Output
host group id a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 deleted successfully
host group id a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 deleted successfully
cs-falcon-update-host-group
Updates a host group.
Base Command
cs-falcon-update-host-group
Input
| Argument Name | Description | Required |
|---|---|---|
| host_group_id | The ID of the host group. | Required |
| name | The name of the host group. | Optional |
| description | The description of the host group. | Optional |
| assignment_rule | The assignment rule. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.HostGroup.id | String | The ID of the host group. |
| CrowdStrike.HostGroup.group_type | String | The group type of the host group. |
| CrowdStrike.HostGroup.name | String | The name of the host group. |
| CrowdStrike.HostGroup.description | String | The description of the host group. |
| CrowdStrike.HostGroup.created_by | String | The client that created the host group. |
| CrowdStrike.HostGroup.created_timestamp | Date | The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.HostGroup.modified_by | String | The client that modified the host group. |
| CrowdStrike.HostGroup.modified_timestamp | Date | The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
Command Example
!cs-falcon-update-host-group host_group_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 name="test_name_update_1" description="test_description_update"
Context Example
{
"CrowdStrike": {
"HostGroup": {
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-22T07:48:35.111070562Z",
"description": "test_description_update",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-25T08:02:05.295663156Z",
"name": "test_name_update_1"
}
}
}
Human Readable Output
Results
assignment_rule created_by created_timestamp description group_type id modified_by modified_timestamp name device_id:[’’],hostname:[’’] api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-22T07:48:35.111070562Z test_description_update static a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-25T08:02:05.295663156Z test_name_update_1
cs-falcon-list-host-group-members
Gets the list of host group members.
Base Command
cs-falcon-list-host-group-members
Input
| Argument Name | Description | Required |
|---|---|---|
| host_group_id | The ID of the host group. | Optional |
| filter | The query to filter the devices that belong to the host group. | Optional |
| offset | Page offset. | Optional |
| limit | The maximum number of results on a page. Default is 50. | Optional |
| sort | The property to sort by (e.g., status.desc or hostname.asc). | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Device.ID | String | The ID of the device. |
| CrowdStrike.Device.LocalIP | String | The local IP address of the device. |
| CrowdStrike.Device.ExternalIP | String | The external IP address of the device. |
| CrowdStrike.Device.Hostname | String | The hostname of the device. |
| CrowdStrike.Device.OS | String | The operating system of the device. |
| CrowdStrike.Device.MacAddress | String | The MAC address of the device. |
| CrowdStrike.Device.FirstSeen | String | The first time the device was seen. |
| CrowdStrike.Device.LastSeen | String | The last time the device was seen. |
| CrowdStrike.Device.Status | String | The device status. |
Command Example
#### Context Example
```json
{
"CrowdStrike": {
"Device": [
{
"ExternalIP": "35.224.136.145",
"FirstSeen": "2021-08-12T16:13:26Z",
"Hostname": "FALCON-CROWDSTR",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"LastSeen": "2021-08-23T04:59:48Z",
"LocalIP": "10.128.0.21",
"MacAddress": "42-01-0a-80-00-15",
"OS": "Windows Server 2019",
"Status": "normal"
},
{
"ExternalIP": "35.224.136.145",
"FirstSeen": "2020-02-10T12:40:18Z",
"Hostname": "FALCON-CROWDSTR",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"LastSeen": "2021-08-25T07:42:47Z",
"LocalIP": "10.128.0.7",
"MacAddress": "42-01-0a-80-00-07",
"OS": "Windows Server 2019",
"Status": "contained"
},
{
"ExternalIP": "35.224.136.145",
"FirstSeen": "2021-08-23T05:04:41Z",
"Hostname": "INSTANCE-1",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"LastSeen": "2021-08-25T07:49:06Z",
"LocalIP": "10.128.0.20",
"MacAddress": "42-01-0a-80-00-14",
"OS": "Windows Server 2019",
"Status": "normal"
},
{
"ExternalIP": "35.224.136.145",
"FirstSeen": "2021-08-11T13:57:29Z",
"Hostname": "INSTANCE-1",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"LastSeen": "2021-08-23T04:45:37Z",
"LocalIP": "10.128.0.20",
"MacAddress": "42-01-0a-80-00-14",
"OS": "Windows Server 2019",
"Status": "normal"
},
{
"ExternalIP": "35.224.136.145",
"FirstSeen": "2021-08-08T11:33:21Z",
"Hostname": "falcon-crowdstrike-sensor-centos7",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"LastSeen": "2021-08-25T07:50:47Z",
"LocalIP": "10.128.0.19",
"MacAddress": "42-01-0a-80-00-13",
"OS": "CentOS 7.9",
"Status": "normal"
}
]
}
}
Human Readable Output
Devices
ID External IP Local IP Hostname OS Mac Address First Seen Last Seen Status a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 35.224.136.145 10.128.0.19 falcon-crowdstrike-sensor-centos7 CentOS 7.9 42-01-0a-80-00-13 2021-08-08T11:33:21Z 2021-08-25T07:50:47Z normal
cs-falcon-add-host-group-members
Add host group members.
Base Command
cs-falcon-add-host-group-members
Input
| Argument Name | Description | Required |
|---|---|---|
| host_group_id | The ID of the host group. | Required |
| host_ids | A comma-separated list of host agent IDs to run commands. The list of host agent IDs can be retrieved by running the ‘cs-falcon-search-device’ command. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.HostGroup.id | String | The ID of the host group. |
| CrowdStrike.HostGroup.group_type | String | The group type of the host group. |
| CrowdStrike.HostGroup.name | String | The name of the host group. |
| CrowdStrike.HostGroup.description | String | The description of the host group. |
| CrowdStrike.HostGroup.created_by | String | The client that created the host group. |
| CrowdStrike.HostGroup.created_timestamp | Date | The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.HostGroup.modified_by | String | The client that modified the host group. |
| CrowdStrike.HostGroup.modified_timestamp | Date | The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
Command Example
!cs-falcon-add-host-group-members host_group_id="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1" host_ids="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
Context Example
{
"CrowdStrike": {
"HostGroup": {
"assignment_rule": "device_id:[''],hostname:['falcon-crowdstrike-sensor-centos7','']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-22T07:48:35.111070562Z",
"description": "test_description_update",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-25T08:02:05.295663156Z",
"name": "test_name_update_1"
}
}
}
Human Readable Output
Results
assignment_rule created_by created_timestamp description group_type id modified_by modified_timestamp name device_id:[’’],hostname:[‘falcon-crowdstrike-sensor-centos7’,’’] api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-22T07:48:35.111070562Z test_description_update static a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-25T08:02:05.295663156Z test_name_update_1
cs-falcon-remove-host-group-members
Remove host group members.
Base Command
cs-falcon-remove-host-group-members
Input
| Argument Name | Description | Required |
|---|---|---|
| host_group_id | The ID of the host group. | Required |
| host_ids | A comma-separated list of host agent IDs to run commands. The list of host agent IDs can be retrieved by running the ‘cs-falcon-search-device’ command. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.HostGroup.id | String | The ID of the host group. |
| CrowdStrike.HostGroup.group_type | String | The group type of the host group. |
| CrowdStrike.HostGroup.name | String | The name of the host group. |
| CrowdStrike.HostGroup.description | String | The description of the host group. |
| CrowdStrike.HostGroup.created_by | String | The client that created the host group. |
| CrowdStrike.HostGroup.created_timestamp | Date | The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
| CrowdStrike.HostGroup.modified_by | String | The client that modified the host group. |
| CrowdStrike.HostGroup.modified_timestamp | Date | The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z. |
Command Example
!cs-falcon-remove-host-group-members host_group_id="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1" host_ids="a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
Context Example
{
"CrowdStrike": {
"HostGroup": {
"assignment_rule": "device_id:[''],hostname:['']",
"created_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_timestamp": "2021-08-22T07:48:35.111070562Z",
"description": "test_description_update",
"group_type": "static",
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_by": "api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"modified_timestamp": "2021-08-25T08:02:05.295663156Z",
"name": "test_name_update_1"
}
}
}
Human Readable Output
Results
assignment_rule created_by created_timestamp description group_type id modified_by modified_timestamp name device_id:[’’],hostname:[’’] api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-22T07:48:35.111070562Z test_description_update static a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 api-client-id:a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2021-08-25T08:02:05.295663156Z test_name_update_1
cs-falcon-batch-upload-custom-ioc
Uploads a batch of indicators.
Base Command
cs-falcon-batch-upload-custom-ioc
Input
| Argument Name | Description | Required |
|---|---|---|
| multiple_indicators_json | A JSON object with a list of CrowdStrike Falcon indicators to upload. | Required |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. Default is 180. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOC.Type | string | The type of the IOC. |
| CrowdStrike.IOC.Value | string | The string representation of the indicator. |
| CrowdStrike.IOC.ID | string | The full ID of the indicator. |
| CrowdStrike.IOC.Severity | string | The severity level to apply to this indicator. |
| CrowdStrike.IOC.Source | string | The source of the IOC. |
| CrowdStrike.IOC.Action | string | The action to take when a host observes the custom IOC. |
| CrowdStrike.IOC.Expiration | string | The datetime the indicator will expire. |
| CrowdStrike.IOC.Description | string | The description of the IOC. |
| CrowdStrike.IOC.CreatedTime | date | The datetime the IOC was created. |
| CrowdStrike.IOC.CreatedBy | string | The identity of the user/process who created the IOC. |
| CrowdStrike.IOC.ModifiedTime | date | The datetime the indicator was last modified. |
| CrowdStrike.IOC.ModifiedBy | string | The identity of the user/process who last updated the IOC. |
| CrowdStrike.IOC.Tags | Unknown | The tags of the IOC. |
| CrowdStrike.IOC.Platforms | Unknown | The platforms of the IOC. |
| CrowdStrike.IOC.MobileAction | string | The action to take on mobile devices when a host observes the custom IOC. |
Command Example
!cs-falcon-batch-upload-custom-ioc multiple_indicators_json=`[{"description": "test", "expiration": "2022-02-17T13:47:57Z", "type": "ipv4", "severity": "Informational", "value": "1.1.8.9", "action": "no_action", "platforms": ["mac"], "source": "Cortex", "applied_globally": true}]`
Context Example
{
"CrowdStrike": {
"IOC": {
"Action": "no_action",
"CreatedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"CreatedTime": "2022-02-16T17:17:25.992164453Z",
"Description": "test",
"Expiration": "2022-02-17T13:47:57Z",
"ID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedBy": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ModifiedTime": "2022-02-16T17:17:25.992164453Z",
"Platforms": [
"mac"
],
"Severity": "informational",
"Source": "Cortex",
"Type": "ipv4",
"Value": "1.1.8.9"
}
}
}
Human Readable Output
Custom IOC 1.1.8.9 was created successfully
Action CreatedBy CreatedTime Description Expiration ID ModifiedBy ModifiedTime Platforms Severity Source Type Value no_action a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T17:17:25.992164453Z test 2022-02-17T13:47:57Z “a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2022-02-16T17:17:25.992164453Z mac informational Cortex ipv4 1.1.8.9
cs-falcon-rtr-kill-process
Execute an active responder kill command on a single host.
Base Command
cs-falcon-rtr-kill-process
Input
| Argument Name | Description | Required |
|---|---|---|
| host_id | The host ID to kill the given process for. | Required |
| process_ids | A comma-separated list of process IDs to kill. | Required |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.kill.ProcessID | String | The process ID that was killed. |
| CrowdStrike.Command.kill.Error | String | The error message raised if the command failed. |
| CrowdStrike.Command.kill.HostID | String | The host ID. |
Command Example
!cs-falcon-rtr-kill-process host_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 process_ids=5260,123
Context Example
{
"CrowdStrike": {
"Command": {
"kill": [
{
"Error": "Cannot find a process with the process identifier 123.",
"HostID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ProcessID": "123"
},
{
"Error": "Success",
"HostID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"ProcessID": "5260"
}
]
}
}
}
Human Readable Output
CrowdStrike Falcon kill command on host a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
|ProcessID|Error|
|—|—|
| 123 | Cannot find a process with the process identifier 123. |
| 5260 | Success |
Note: you don’t see the following IDs in the results as the request was failed for them.
ID 123 failed as it was not found.
cs-falcon-rtr-remove-file
Batch executes an RTR active-responder remove file across the hosts mapped to the given batch ID.
Base Command
cs-falcon-rtr-remove-file
Input
| Argument Name | Description | Required |
|---|---|---|
| host_ids | A comma-separated list of the hosts IDs to remove the file for. | Required |
| file_path | The path to a file or a directory to remove. | Required |
| os | The operating system of the hosts given. Since the remove command is different in each operating system, you can choose only one operating system. Possible values are: Windows, Linux, Mac. | Required |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.rm.HostID | String | The host ID. |
| CrowdStrike.Command.rm.Error | String | The error message raised if the command failed. |
Command Example
!cs-falcon-rtr-remove-file file_path="c:\\testfolder" host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 os=Windows
Context Example
{
"CrowdStrike": {
"Command": {
"rm": {
"Error": "Success",
"HostID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
}
}
}
Human Readable Output
CrowdStrike Falcon rm over the file: c:\testfolder
HostID Error a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 Success
cs-falcon-rtr-list-processes
Executes an RTR active-responder ps command to get a list of active processes across the given host.
Base Command
cs-falcon-rtr-list-processes
Input
| Argument Name | Description | Required |
|---|---|---|
| host_id | The host ID to get the processes list from. | Required |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.ps.Filename | String | The name of the result file to be returned. |
Command Example
!cs-falcon-rtr-list-processes host_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Context Example
{
"CrowdStrike": {
"Command": {
"ps": {
"Filename": "ps-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
}
},
"File": {
"EntryID": "1792@5e02fcd0-37ad-4124-836d-7e769ba0ae86",
"Info": "text/plain",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Name": "ps-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA1": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a115919af3",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA512": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SSDeep": "768:4jcAkTBaZ61QUEcDBdMoFwIxVvroYrohrbY2akHLnsa5fbqFEJtPNObzVj0ff+3K:4IraZ61QUEcDBdMoFwIxRJEbY2akHLnr",
"Size": 30798,
"Type": "ASCII text"
}
}
Human Readable Output
CrowdStrike Falcon ps command on host a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Stdout TOO MUCH INFO TO DISPLAY
cs-falcon-rtr-list-network-stats
Executes an RTR active-responder netstat command to get a list of network status and protocol statistics across the given host.
Base Command
cs-falcon-rtr-list-network-stats
Input
| Argument Name | Description | Required |
|---|---|---|
| host_id | The host ID to get the network status and protocol statistics list from. | Required |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Command.netstat.Filename | String | The name of the result file to be returned. |
Command Example
!cs-falcon-rtr-list-network-stats host_id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Context Example
{
"CrowdStrike": {
"Command": {
"netstat": {
"Filename": "netstat-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
}
},
"File": {
"EntryID": "1797@5e02fcd0-37ad-4124-836d-7e769ba0ae86",
"Info": "text/plain",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Name": "netstat-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA1": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1864ce595",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA512": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SSDeep": "48:XSvprPoeCfd8saowYL8zjt6yjjRchg24OI58RtTLvWptl6TtCla5n1lEtClMw/u:CRQeCxRmxVpIHUchCIvsCo",
"Size": 4987,
"Type": "ASCII text, with CRLF line terminators"
}
}
Human Readable Output
CrowdStrike Falcon netstat command on host a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Stdout TOO MUCH INFO TO DISPLAY
cs-falcon-rtr-read-registry
Executes an RTR active-responder read registry keys command across the given hosts. This command is valid only for Windows hosts.
Base Command
cs-falcon-rtr-read-registry
Input
| Argument Name | Description | Required |
|---|---|---|
| host_ids | A comma-separated list of the host IDs to get the registry keys from. | Required |
| registry_keys | A comma-separated list of the registry keys, sub-keys, or value to get. | Required |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-rtr-read-registry host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 registry_keys=`
HKEY_LOCAL_MACHINE,HKEY_USERS`
Context Example
{
"File": [
{
"EntryID": "1806@5e02fcd0-37ad-4124-836d-7e769ba0ae86",
"Info": "text/plain",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Name": "reg-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1HKEY_USERS",
"SHA1": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a139dd0333",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA512": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SSDeep": "12:uSn3PtdoI1pZI2WUNI2e6NI2vboI2vbP3I2zd:uSQIpZIII1aIUMIUjIcd",
"Size": 656,
"Type": "ASCII text, with CRLF, LF line terminators"
},
{
"EntryID": "1807@5e02fcd0-37ad-4124-836d-7e769ba0ae86",
"Info": "text/plain",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Name": "reg-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1HKEY_LOCAL_MACHINE",
"SHA1": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a18e3b4919",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA512": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SSDeep": "6:zYuSugMQEYPtdWCMwdiwf2Jai2FU42DGE25/:zYuSnMQXPtd9/eJqy7yfh",
"Size": 320,
"Type": "ASCII text, with CRLF, LF line terminators"
}
]
}
Human Readable Output
CrowdStrike Falcon reg command on hosts [‘a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1’]
FileName Stdout reg-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1HKEY_USERS TOO MUCH INFO TO DISPLAY reg-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1HKEY_LOCAL_MACHINE TOO MUCH INFO TO DISPLAY
cs-falcon-rtr-list-scheduled-tasks
Executes an RTR active-responder netstat command to get a list of scheduled tasks across the given host. This command is valid only for Windows hosts.
Base Command
cs-falcon-rtr-list-scheduled-tasks
Input
| Argument Name | Description | Required |
|---|---|---|
| host_ids | A comma-separated list of the hosts IDs to get the list of scheduled tasks from. | Required |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-rtr-list-scheduled-tasks host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Context Example
{
"CrowdStrike": {
"Command": {
"runscript": {
"Filename": "runscript-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
}
},
"File": {
"EntryID": "1812@5e02fcd0-37ad-4124-836d-7e769ba0ae86",
"Info": "text/plain",
"MD5": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"Name": "runscript-a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA1": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1c589bf80",
"SHA256": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SHA512": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"SSDeep": "3072:zjQ3/3YHGa8dbXbpbItbo4W444ibNb9MTf2Wat4cuuEqk4W4ybmF54c4eEEEjX6f:EXN8Nbw",
"Size": 299252,
"Type": "ASCII text"
}
}
Human Readable Output
CrowdStrike Falcon runscript command on host a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Stdout TOO MUCH INFO TO DISPLAY
cs-falcon-rtr-retrieve-file
Gets the RTR extracted file contents for the specified file path.
Base Command
cs-falcon-rtr-retrieve-file
Input
| Argument Name | Description | Required |
|---|---|---|
| host_ids | A comma-separated list of the hosts IDs to get the file from. | Required |
| file_path | The file path of the required file to extract. | Required |
| filename | The filename to use for the archive name and the file within the archive. | Optional |
| interval_in_seconds | Interval between polling. Default is 60 seconds. Must be higher than 10. | Optional |
| hosts_and_requests_ids | This is an internal argument used for the polling process, not to be used by the user. | Optional |
| SHA256 | This is an internal argument used for the polling process, not to be used by the user. | Optional |
| queue_offline | Whether the command will run against an offline-queued session and be queued for execution when the host comes online. | Optional |
| timeout | The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. | Optional |
| polling_timeout | Timeout for polling. Default is 600 seconds. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.File.FileName | String | The filename. |
| CrowdStrike.File.HostID | String | The host ID. |
| File.Size | Number | The size of the file. |
| File.SHA1 | String | The SHA1 hash of the file. |
| File.SHA256 | String | The SHA256 hash of the file. |
| File.SHA512 | String | The SHA512 hash of the file. |
| File.Name | String | The name of the file. |
| File.SSDeep | String | The SSDeep hash of the file. |
| File.EntryID | String | The entry ID of the file. |
| File.Info | String | Information about the file. |
| File.Type | String | The file type. |
| File.MD5 | String | The MD5 hash of the file. |
| File.Extension | String | The extension of the file. |
Command Example
!cs-falcon-rtr-retrieve-file file_path=`C:\Windows\System32\Windows.Media.FaceAnalysis.dll` host_ids=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1,a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
Human Readable Output
Waiting for the polling execution
get-mapping-fields
Returns the list of fields to map in outgoing mirroring. This command is only used for debugging purposes. Note that this command is supported in Cortex XSOAR only.
Base Command
get-mapping-fields
Input
| Argument Name | Description | Required |
| — | — | — |
Context Output
There is no context output for this command.
get-remote-data
Gets remote data from a remote incident or detection. This method does not update the current incident or detection, and should be used for debugging purposes only. Note that this command is supported in Cortex XSOAR only.
Base Command
get-remote-data
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The remote incident or detection ID. | Required |
| lastUpdate | The UTC timestamp in seconds of the last update. The incident or detection is only updated if it was modified after the last update time. Default is 0. | Optional |
Context Output
There is no context output for this command.
get-modified-remote-data
Gets the list of incidents and detections that were modified since the last update time. This method is used for debugging purposes. The get-modified-remote-data command is used as part of the Mirroring feature that was introduced in Cortex XSOAR version 6.1. Note that this command is supported in Cortex XSOAR only.
Base Command
get-modified-remote-data
Input
| Argument Name | Description | Required |
|---|---|---|
| lastUpdate | Date string representing the local time in UTC timestamp in seconds. The incident or detection is only returned if it was modified after the last update time. | Optional |
Context Output
There is no context output for this command.
update-remote-system
Updates the remote incident or detection with local incident or detection changes. This method is only used for debugging purposes and will not update the current incident or detection. Note that this command is supported in Cortex XSOAR only.
Base Command
update-remote-system
Input
| Argument Name | Description | Required |
| — | — | — |
Context Output
There is no context output for this command.
cve
Retrieve vulnerability details according to the selected filter. Each request requires at least one filter parameter. Supported with the CrowdStrike Spotlight license.
Base Command
cve
Input
| Argument Name | Description | Required |
|---|---|---|
| cve_id | Deprecated. Use cve instead. | Optional |
| cve | Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). This filter supports multiple values and negation. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| DBotScore.Indicator | String | The indicator that was tested. |
| DBotScore.Type | String | The indicator type. |
| DBotScore.Vendor | String | The vendor used to calculate the score. |
| DBotScore.Score | Number | The actual score. |
Command Example
cve cve=CVE-2021-2222
Human Readable Output
| ID | Severity | Published Date | Base Score |
|---|---|---|---|
| CVE-2021-2222 | HIGH | 2021-09-16T15:12:42Z | 1 |
cs-falcon-create-ml-exclusion
Create an ML exclusion.
Base Command
cs-falcon-create-ml-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| value | Value to match for exclusion. | Required |
| excluded_from | A comma-separated list from where to exclude the exclusion. Possible values are: blocking, extraction. | Required |
| comment | Comment describing why the exclusions were created. | Optional |
| groups | A comma-separated list of group ID(s) impacted by the exclusion OR all if empty. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.MLExclusion.id | String | The ML exclusion ID. |
| CrowdStrike.MLExclusion.value | String | The ML exclusion value. |
| CrowdStrike.MLExclusion.regexp_value | String | A regular expression for matching the excluded value. |
| CrowdStrike.MLExclusion.value_hash | String | An hash of the value field. |
| CrowdStrike.MLExclusion.excluded_from | String | What the exclusion applies to (e.g., a specific ML model). |
| CrowdStrike.MLExclusion.groups.id | String | Group ID that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.group_type | String | Group type that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.name | String | Group name that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.description | String | Group description that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.assignment_rule | String | Group assignment rule that the exclusion is associated with. |
| CrowdStrike.MLExclusion.groups.created_by | String | Indicate who created the group. |
| CrowdStrike.MLExclusion.groups.created_timestamp | Date | The date when the group was created. |
| CrowdStrike.MLExclusion.groups.modified_by | String | Indicate who last modified the group. |
| CrowdStrike.MLExclusion.groups.modified_timestamp | Date | The date when the group was last modified. |
| CrowdStrike.MLExclusion.applied_globally | Boolean | Whether the exclusion rule applies globally or only to specific entities. |
| CrowdStrike.MLExclusion.last_modified | Date | The date when the exclusion rule was last modified. |
| CrowdStrike.MLExclusion.modified_by | String | Indicate who last modified the rule. |
| CrowdStrike.MLExclusion.created_on | Date | The date when the exclusion rule was created. |
| CrowdStrike.MLExclusion.created_by | String | Indicate who created the rule. |
Command Example
!cs-falcon-create-ml-exclusion value=/demo-test excluded_from=blocking groups=999999
Context Example
{
"CrowdStrike": {
"MLExclusion": {
"applied_globally": false,
"created_by": "api-client-id:123456",
"created_on": "2023-03-06T13:57:14.853546312Z",
"excluded_from": [
"blocking"
],
"groups": [
{
"assignment_rule": "device_id",
"created_by": "admin@test.com",
"created_timestamp": "2023-01-23T15:01:11.846726918Z",
"description": "",
"group_type": "static",
"id": "999999",
"modified_by": "admin@test.com",
"modified_timestamp": "2023-01-23T15:18:52.316882546Z",
"name": "Lab env"
}
],
"id": "123456",
"last_modified": "2023-03-06T13:57:14.853546312Z",
"modified_by": "api-client-id:123456",
"regexp_value": "\\/demo-test",
"value": "/demo-test",
"value_hash": "abcdef123456"
}
}
}
Human Readable Output
CrowdStrike Falcon machine learning exclusion
Id Value RegexpValue ValueHash ExcludedFrom Groups AppliedGlobally LastModified ModifiedBy CreatedOn CreatedBy 123456 /demo-test \/demo-test abcdef123456 values: blocking - id: 999999
group_type: static
name: Lab env
description:
assignment_rule: device_id:
created_by: admin@test.com
created_timestamp: 2023-01-23T15:01:11.846726918Z
modified_by: admin@test.com
modified_timestamp: 2023-01-23T15:18:52.316882546Z2023-03-06T13:57:14.853546312Z api-client-id:123456 2023-03-06T13:57:14.853546312Z api-client-id:123456
cs-falcon-update-ml-exclusion
Updates an ML exclusion. At least one argument is required in addition to the id argument.
Base Command
cs-falcon-update-ml-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the exclusion to update. | Required |
| value | Value to match for the exclusion (the exclusion pattern). | Optional |
| comment | Comment describing why the exclusions were created. | Optional |
| groups | A comma-separated list of group ID(s) impacted by the exclusion. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.MLExclusion.id | String | The ML exclusion ID. |
| CrowdStrike.MLExclusion.value | String | The ML exclusion value. |
| CrowdStrike.MLExclusion.regexp_value | String | A regular expression for matching the excluded value. |
| CrowdStrike.MLExclusion.value_hash | String | A hash of the value field. |
| CrowdStrike.MLExclusion.excluded_from | String | What the exclusion applies to (e.g., a specific ML model). |
| CrowdStrike.MLExclusion.groups.id | String | Group ID that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.group_type | String | Group type that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.name | String | Group name that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.description | String | Group description that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.assignment_rule | String | Group assignment rule that the exclusion is associated with. |
| CrowdStrike.MLExclusion.groups.created_by | String | Indicate who created the group. |
| CrowdStrike.MLExclusion.groups.created_timestamp | Date | The date when the group was created. |
| CrowdStrike.MLExclusion.groups.modified_by | String | Indicate who last modified the group. |
| CrowdStrike.MLExclusion.groups.modified_timestamp | Date | The date when the group was last modified. |
| CrowdStrike.MLExclusion.applied_globally | Boolean | Whether the exclusion rule applies globally or only to specific entities. |
| CrowdStrike.MLExclusion.last_modified | Date | The date when the exclusion rule was last modified. |
| CrowdStrike.MLExclusion.modified_by | String | Indicate who last modified the rule. |
| CrowdStrike.MLExclusion.created_on | Date | The date when the exclusion rule was created. |
| CrowdStrike.MLExclusion.created_by | String | Indicate who created the rule. |
Command Example
!cs-falcon-update-ml-exclusion id=a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 comment=demo-comment
Context Example
{
"CrowdStrike": {
"MLExclusion": {
"applied_globally": false,
"created_by": "api-client-id:123456",
"created_on": "2023-03-06T13:56:25.940685483Z",
"excluded_from": [
"extraction",
"blocking"
],
"groups": [
{
"assignment_rule": "device_id:",
"created_by": "admin@test.com",
"created_timestamp": "2023-01-23T15:01:11.846726918Z",
"description": "",
"group_type": "static",
"id": "999999",
"modified_by": "admin@test.com",
"modified_timestamp": "2023-01-23T15:18:52.316882546Z",
"name": "Lab env"
}
],
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"last_modified": "2023-03-06T13:57:21.57829431Z",
"modified_by": "api-client-id:123456",
"regexp_value": "\\/demo",
"value": "/demo",
"value_hash": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
}
}
}
Human Readable Output
CrowdStrike Falcon machine learning exclusion
Id Value RegexpValue ValueHash ExcludedFrom Groups AppliedGlobally LastModified ModifiedBy CreatedOn CreatedBy a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 /demo \/demo a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 values: extraction, blocking - id: 999999
group_type: static
name: Lab env
description:
assignment_rule: device_id:
created_by: admin@test.com
created_timestamp: 2023-01-23T15:01:11.846726918Z
modified_by: admin@test.com
modified_timestamp: 2023-01-23T15:18:52.316882546Z2023-03-06T13:57:21.57829431Z api-client-id:123456 2023-03-06T13:56:25.940685483Z api-client-id:123456
cs-falcon-delete-ml-exclusion
Delete the ML exclusions by ID.
Base Command
cs-falcon-delete-ml-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of exclusion IDs to delete. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-delete-ml-exclusion ids=123456
Human Readable Output
‘The machine learning exclusions with IDs ‘123456’ was successfully deleted.’
cs-falcon-search-ml-exclusion
Get a list of ML exclusions by specifying their IDs, value, or a specific filter.
Base Command
cs-falcon-search-ml-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | A custom filter by which the exclusions should be filtered. The syntax follows the pattern <property>:[operator]'<value>'. For example: value:’test’.Available filters: applied_globally, created_by, created_on, last_modified, modified_by, value. For more information, see: https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql. |
Optional |
| value | The value by which the exclusions should be filtered. | Optional |
| ids | A comma-separated list of exclusion IDs to retrieve. The IDs overwrite the filter and value. | Optional |
| limit | The maximum number of records to return. [1-500]. Applies only if the ids argument is not supplied. | Optional |
| offset | The offset to start retrieving records from. Applies only if the ids argument is not supplied. | Optional |
| sort | How to sort the retrieved exclusions. Possible values are: applied_globally.asc, applied_globally.desc, created_by.asc, created_by.desc, created_on.asc, created_on.desc, last_modified.asc, last_modified.desc, modified_by.asc, modified_by.desc, value.asc, value.desc. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.MLExclusion.id | String | The ML exclusion ID. |
| CrowdStrike.MLExclusion.value | String | The ML exclusion value. |
| CrowdStrike.MLExclusion.regexp_value | String | A regular expression for matching the excluded value. |
| CrowdStrike.MLExclusion.value_hash | String | A hash of the value field. |
| CrowdStrike.MLExclusion.excluded_from | String | What the exclusion applies to (e.g., a specific ML model). |
| CrowdStrike.MLExclusion.groups.id | String | Group ID that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.group_type | String | Group type that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.name | String | Group name that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.description | String | Group description that the exclusion rule is associated with. |
| CrowdStrike.MLExclusion.groups.assignment_rule | String | Group assignment rule that the exclusion is associated with. |
| CrowdStrike.MLExclusion.groups.created_by | String | Indicate who created the group. |
| CrowdStrike.MLExclusion.groups.created_timestamp | Date | The date when the group was created. |
| CrowdStrike.MLExclusion.groups.modified_by | String | Indicate who last modified the group. |
| CrowdStrike.MLExclusion.groups.modified_timestamp | Date | The date when the group was last modified. |
| CrowdStrike.MLExclusion.applied_globally | Boolean | Whether the exclusion rule applies globally or only to specific entities. |
| CrowdStrike.MLExclusion.last_modified | Date | The date when the exclusion rule was last modified. |
| CrowdStrike.MLExclusion.modified_by | String | Indicate who last modified the rule. |
| CrowdStrike.MLExclusion.created_on | Date | The date when the exclusion rule was created. |
| CrowdStrike.MLExclusion.created_by | String | Indicate who created the rule. |
Command Example
!cs-falcon-search-ml-exclusion limit=1
Context Example
{
"CrowdStrike": {
"MLExclusion": {
"applied_globally": false,
"created_by": "api-client-id:123456",
"created_on": "2023-03-01T18:51:07.196018144Z",
"excluded_from": [
"blocking"
],
"groups": [
{
"assignment_rule": "device_id",
"created_by": "admin@test.com",
"created_timestamp": "2023-01-23T15:01:11.846726918Z",
"description": "",
"group_type": "static",
"id": "999999",
"modified_by": "admin@test.com",
"modified_timestamp": "2023-01-23T15:18:52.316882546Z",
"name": "Lab env"
}
],
"id": "123456",
"last_modified": "2023-03-01T18:51:07.196018144Z",
"modified_by": "api-client-id:123456",
"regexp_value": "\\/MosheTest2-432",
"value": "/MosheTest2-432",
"value_hash": "abcdef123456"
}
}
}
Human Readable Output
CrowdStrike Falcon machine learning exclusions
Id Value RegexpValue ValueHash ExcludedFrom Groups AppliedGlobally LastModified ModifiedBy CreatedOn CreatedBy 123456 /MosheTest2-432 \/MosheTest2-432 abcdef123456 values: blocking - id: 999999
group_type: static
name: Lab env
description:
assignment_rule: device_id
created_by: admin@test.com
created_timestamp: 2023-01-23T15:01:11.846726918Z
modified_by: admin@test.com
modified_timestamp: 2023-01-23T15:18:52.316882546Z2023-03-01T18:51:07.196018144Z api-client-id:123456 2023-03-01T18:51:07.196018144Z api-client-id:123456
cs-falcon-create-ioa-exclusion
Create an IOA exclusion.
Base Command
cs-falcon-create-ioa-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| exclusion_name | Name of the exclusion. | Required |
| pattern_name | Name of the exclusion pattern. | Optional |
| pattern_id | ID of the exclusion pattern. | Required |
| cl_regex | Command line regular expression. | Required |
| ifn_regex | Image filename regular expression. | Required |
| comment | Comment describing why the exclusions were created. | Optional |
| description | Exclusion description. | Optional |
| detection_json | JSON formatted detection template. | Optional |
| groups | A comma-separated list of group ID(s) impacted by the exclusion OR all if empty. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOAExclusion.id | String | A unique identifier for the IOA exclusion. |
| CrowdStrike.IOAExclusion.name | String | The name of the IOA exclusion. |
| CrowdStrike.IOAExclusion.description | String | A description of the IOA exclusion. |
| CrowdStrike.IOAExclusion.pattern_id | String | The identifier of the pattern associated with the IOA exclusion. |
| CrowdStrike.IOAExclusion.pattern_name | String | The name of the pattern associated with the IOA exclusion. |
| CrowdStrike.IOAExclusion.ifn_regex | String | A regular expression used for filename matching. |
| CrowdStrike.IOAExclusion.cl_regex | String | A regular expression used for command line matching. |
| CrowdStrike.IOAExclusion.detection_json | String | A JSON string that describes the detection logic for the IOA exclusion. |
| CrowdStrike.IOAExclusion.groups.id | String | Group ID that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.group_type | String | Group type that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.name | String | Group name that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.description | String | Group description that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.assignment_rule | String | Group assignment rule that the exclusion is associated with. |
| CrowdStrike.IOAExclusion.groups.created_by | String | Indicate who created the group. |
| CrowdStrike.IOAExclusion.groups.created_timestamp | Date | The date when the group was created. |
| CrowdStrike.IOAExclusion.groups.modified_by | String | Indicate who last modified the group. |
| CrowdStrike.IOAExclusion.groups.modified_timestamp | Date | The date when the group was last modified. |
| CrowdStrike.IOAExclusion.applied_globally | Boolean | Whether the exclusion rule applies globally or only to specific entities. |
| CrowdStrike.IOAExclusion.last_modified | Date | The date when the exclusion rule was last modified. |
| CrowdStrike.IOAExclusion.modified_by | String | Indicate who last modified the rule. |
| CrowdStrike.IOAExclusion.created_on | Date | The date when the exclusion rule was created. |
| CrowdStrike.IOAExclusion.created_by | String | Indicate who created the rule. |
Command Example
!cs-falcon-create-ioa-exclusion exclusion_name=demo-test pattern_id=101010 cl_regex=.* ifn_regex="c:\\\\windows\\\\system32\\\\test.exe" groups=999999
Context Example
{
"CrowdStrike": {
"IOAExclusion": {
"applied_globally": false,
"cl_regex": ".*",
"created_by": "api-client-id:123456",
"created_on": "2023-03-06T13:57:41.746172897Z",
"description": "",
"detection_json": "",
"groups": [
{
"assignment_rule": "device_id",
"created_by": "admin@test.com",
"created_timestamp": "2023-01-23T15:01:11.846726918Z",
"description": "",
"group_type": "static",
"id": "999999",
"modified_by": "admin@test.com",
"modified_timestamp": "2023-01-23T15:18:52.316882546Z",
"name": "Lab env"
}
],
"id": "123456",
"ifn_regex": "c:\\\\windows\\\\system32\\\\test.exe",
"last_modified": "2023-03-06T13:57:41.746172897Z",
"modified_by": "api-client-id:123456",
"name": "demo-test",
"pattern_id": "101010",
"pattern_name": ""
}
}
}
Human Readable Output
CrowdStrike Falcon IOA exclusion
Id Name PatternId IfnRegex ClRegex Groups AppliedGlobally LastModified ModifiedBy CreatedOn CreatedBy 123456 demo-test 101010 c:\windows\system32\poqexec.exe .* - id: 999999
group_type: static
name: Lab env
description:
assignment_rule: device_id
created_by: admin@test.com
created_timestamp: 2023-01-23T15:01:11.846726918Z
modified_by: admin@test.com
modified_timestamp: 2023-01-23T15:18:52.316882546Z2023-03-06T13:57:41.746172897Z api-client-id:123456 2023-03-06T13:57:41.746172897Z api-client-id:123456
cs-falcon-update-ioa-exclusion
Updates an IOA exclusion. At least one argument is required in addition to the id argument.
Base Command
cs-falcon-update-ioa-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| id | ID of the exclusion to update. | Required |
| exclusion_name | Name of the exclusion. | Optional |
| pattern_id | ID of the exclusion pattern to update. | Optional |
| pattern_name | Name of the exclusion pattern. | Optional |
| cl_regex | Command line regular expression. | Optional |
| ifn_regex | Image filename regular expression. | Optional |
| comment | Comment describing why the exclusions was created. | Optional |
| description | Exclusion description. | Optional |
| detection_json | JSON formatted detection template. | Optional |
| groups | A comma-separated list of group ID(s) impacted by the exclusion. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOAExclusion.id | String | A unique identifier for the IOA exclusion. |
| CrowdStrike.IOAExclusion.name | String | The name of the IOA exclusion. |
| CrowdStrike.IOAExclusion.description | String | A description of the IOA exclusion. |
| CrowdStrike.IOAExclusion.pattern_id | String | The identifier of the pattern associated with the IOA exclusion. |
| CrowdStrike.IOAExclusion.pattern_name | String | The name of the pattern associated with the IOA exclusion. |
| CrowdStrike.IOAExclusion.ifn_regex | String | A regular expression used for filename matching. |
| CrowdStrike.IOAExclusion.cl_regex | String | A regular expression used for command line matching. |
| CrowdStrike.IOAExclusion.detection_json | String | A JSON string that describes the detection logic for the IOA exclusion. |
| CrowdStrike.IOAExclusion.groups.id | String | Group ID that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.group_type | String | Group type that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.name | String | Group name that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.description | String | Group description that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.assignment_rule | String | Group assignment rule that the exclusion is associated with. |
| CrowdStrike.IOAExclusion.groups.created_by | String | Indicate who created the group. |
| CrowdStrike.IOAExclusion.groups.created_timestamp | Date | The date when the group was created. |
| CrowdStrike.IOAExclusion.groups.modified_by | String | Indicate who last modified the group. |
| CrowdStrike.IOAExclusion.groups.modified_timestamp | Date | The date when the group was last modified. |
| CrowdStrike.IOAExclusion.applied_globally | Boolean | Whether the exclusion rule applies globally or only to specific entities. |
| CrowdStrike.IOAExclusion.last_modified | Date | The date when the exclusion rule was last modified. |
| CrowdStrike.IOAExclusion.modified_by | String | Indicate who last modified the rule. |
| CrowdStrike.IOAExclusion.created_on | Date | The date when the exclusion rule was created. |
| CrowdStrike.IOAExclusion.created_by | String | Indicate who created the rule. |
Command Example
!cs-falcon-update-ioa-exclusion id=123456 description=demo-description
Context Example
{
"CrowdStrike": {
"IOAExclusion": {
"applied_globally": false,
"cl_regex": ".*",
"created_by": "api-client-id:123456",
"created_on": "2023-03-06T13:46:58.137122925Z",
"description": "demo-description",
"detection_json": "",
"groups": [
{
"assignment_rule": "device_id",
"created_by": "admin@test.com",
"created_timestamp": "2023-01-23T15:01:11.846726918Z",
"description": "",
"group_type": "static",
"id": "999999",
"modified_by": "admin@test.com",
"modified_timestamp": "2023-01-23T15:18:52.316882546Z",
"name": "Lab env"
}
],
"id": "123456",
"ifn_regex": "c:\\\\windows\\\\system32\\\\poqexec\\.exe",
"last_modified": "2023-03-06T13:57:49.086458198Z",
"modified_by": "api-client-id:123456",
"name": "demo",
"pattern_id": "101010",
"pattern_name": ""
}
}
}
Human Readable Output
CrowdStrike Falcon IOA exclusion
Id Name Description PatternId IfnRegex ClRegex Groups AppliedGlobally LastModified ModifiedBy CreatedOn CreatedBy 123456 demo demo-description 101010 c:\windows\system32\poqexec.exe .* - id: 999999
group_type: static
name: Lab env
description:
assignment_rule: device_id
created_by: admin@test.com
created_timestamp: 2023-01-23T15:01:11.846726918Z
modified_by: admin@test.com
modified_timestamp: 2023-01-23T15:18:52.316882546Z2023-03-06T13:57:49.086458198Z api-client-id:123456 2023-03-06T13:46:58.137122925Z api-client-id:123456
cs-falcon-delete-ioa-exclusion
Delete the IOA exclusions by ID.
Base Command
cs-falcon-delete-ioa-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of exclusion IDs to delete. | Required |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-delete-ioa-exclusion ids=123456
Human Readable Output
‘The IOA exclusions with IDs ‘123456’ was successfully deleted.’
cs-falcon-search-ioa-exclusion
Get a list of IOA exclusions by specifying their IDs or a filter.
Base Command
cs-falcon-search-ioa-exclusion
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | A custom filter by which the exclusions should be filtered. The syntax follows the pattern <property>:[operator]'<value>'. For example: name:’test’.Available filters: applied_globally, created_by, created_on, name, last_modified, modified_by, value, pattern. For more information, see: https://www.falconpy.io/Service-Collections/Falcon-Query-Language. |
Optional |
| name | The name by which the exclusions should be filtered. | Optional |
| ids | A comma-separated list of exclusion IDs to retrieve. The IDs overwrite the filter and name. | Optional |
| limit | The limit of how many exclusions to retrieve. Default is 50. Applies only if the ids argument is not supplied. | Optional |
| offset | The offset of how many exclusions to skip. Default is 0. Applies only if the ids argument is not supplied. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOAExclusion.id | String | A unique identifier for the IOA exclusion. |
| CrowdStrike.IOAExclusion.name | String | The name of the IOA exclusion. |
| CrowdStrike.IOAExclusion.description | String | A description of the IOA exclusion. |
| CrowdStrike.IOAExclusion.pattern_id | String | The identifier of the pattern associated with the IOA exclusion. |
| CrowdStrike.IOAExclusion.pattern_name | String | The name of the pattern associated with the IOA exclusion. |
| CrowdStrike.IOAExclusion.ifn_regex | String | A regular expression used for filename matching. |
| CrowdStrike.IOAExclusion.cl_regex | String | A regular expression used for command line matching. |
| CrowdStrike.IOAExclusion.detection_json | String | A JSON string that describes the detection logic for the IOA exclusion. |
| CrowdStrike.IOAExclusion.groups.id | String | Group ID that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.group_type | String | Group type that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.name | String | Group name that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.description | String | Group description that the exclusion rule is associated with. |
| CrowdStrike.IOAExclusion.groups.assignment_rule | String | Group assignment rule that the exclusion is associated with. |
| CrowdStrike.IOAExclusion.groups.created_by | String | Indicate who created the group. |
| CrowdStrike.IOAExclusion.groups.created_timestamp | Date | The date when the group was created. |
| CrowdStrike.IOAExclusion.groups.modified_by | String | Indicate who last modified the group. |
| CrowdStrike.IOAExclusion.groups.modified_timestamp | Date | The date when the group was last modified. |
| CrowdStrike.IOAExclusion.applied_globally | Boolean | Whether the exclusion rule applies globally or only to specific entities. |
| CrowdStrike.IOAExclusion.last_modified | Date | The date when the exclusion rule was last modified. |
| CrowdStrike.IOAExclusion.modified_by | String | Indicate who last modified the rule. |
| CrowdStrike.IOAExclusion.created_on | Date | The date when the exclusion rule was created. |
| CrowdStrike.IOAExclusion.created_by | String | Indicate who created the rule. |
Command Example
!cs-falcon-search-ioa-exclusion limit=1
Context Example
{
"CrowdStrike": {
"IOAExclusion": {
"applied_globally": true,
"cl_regex": "regex",
"created_by": "user@test.com",
"created_on": "2023-02-06T16:42:19.29906839Z",
"description": "demo description",
"detection_json": "",
"groups": [],
"id": "123456",
"ifn_regex": ".*\\\\Windows\\\\System32\\\\choice\\.exe",
"last_modified": "2023-02-26T15:30:04.554767735Z",
"modified_by": "api-client-id:123456",
"name": "My IOA Exclusion",
"pattern_id": "101010",
"pattern_name": "P_name"
}
}
}
Human Readable Output
CrowdStrike Falcon IOA exclusions
Id Name Description PatternId PatternName IfnRegex ClRegex AppliedGlobally LastModified ModifiedBy CreatedOn CreatedBy 123456 My IOA Exclusion demo description 101010 P_name .*\Windows\System32\choice.exe choice\s+/m\s+crowdstrike_sample_detection 2023-02-26T15:30:04.554767735Z api-client-id:123456 2023-02-06T16:42:19.29906839Z user@test.com
cs-falcon-list-quarantined-file
Get quarantine file metadata by specified IDs or filter.
Base Command
cs-falcon-list-quarantined-file
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of quarantined file IDs to retrieve. | Optional |
| filter | A custom filter by which the retrieved quarantined file should be filtered. | Optional |
| sha256 | A comma-separated list of SHA256 hash of the files to retrieve. | Optional |
| filename | A comma-separated list of the name of the files to retrieve. | Optional |
| state | Filter the retrieved files by state. | Optional |
| hostname | A comma-separated list of the hostnames of the files to retrieve. | Optional |
| username | A comma-separated list of the usernames of the files to retrieve. | Optional |
| limit | Maximum number of IDs to return. Max 5000. Default 50. | Optional |
| offset | Starting index of the overall result set from which to return IDs. Default 0. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.QuarantinedFile.id | String | A unique identifier for the quarantined file. |
| CrowdStrike.QuarantinedFile.aid | String | The agent identifier of the agent that quarantined the file. |
| CrowdStrike.QuarantinedFile.cid | String | The unique customer identifier of the agent that quarantined the file. |
| CrowdStrike.QuarantinedFile.sha256 | String | The SHA256 hash value of the quarantined file. |
| CrowdStrike.QuarantinedFile.paths.path | String | The full path of the quarantined file. |
| CrowdStrike.QuarantinedFile.paths.filename | String | The name of the quarantined file. |
| CrowdStrike.QuarantinedFile.paths.state | String | The current state of the quarantined file path (e.g., “purged”). |
| CrowdStrike.QuarantinedFile.state | String | The current state of the quarantined file (e.g., “unrelease_pending”). |
| CrowdStrike.QuarantinedFile.detect_ids | String | The detection identifiers associated with the quarantined file. |
| CrowdStrike.QuarantinedFile.hostname | String | The hostname of the agent that quarantined the file. |
| CrowdStrike.QuarantinedFile.username | String | The username associated with the quarantined file. |
| CrowdStrike.QuarantinedFile.date_updated | Date | The date the quarantined file was last updated. |
| CrowdStrike.QuarantinedFile.date_created | Date | The date the quarantined file was created. |
Command Example
!cs-falcon-list-quarantined-file limit=1
Context Example
{
"CrowdStrike": {
"QuarantinedFile": {
"aid": "a123456",
"cid": "c123456",
"date_created": "2022-12-13T14:23:49Z",
"date_updated": "2023-03-06T13:47:30Z",
"detect_ids": [
"ldt:a123456:456789"
],
"hostname": "INSTANCE-1",
"id": "a123456_sha123456",
"paths": [
{
"filename": "nc.exe",
"path": "\\Device\\HarddiskVolume3\\Users\\admin\\Downloads\\hamuzim\\test.exe",
"state": "quarantined"
}
],
"sha256": "sha123456",
"state": "deleted",
"username": "admin"
}
}
}
Human Readable Output
CrowdStrike Falcon Quarantined File
Id Aid Cid Sha256 Paths State DetectIds Hostname Username DateUpdated DateCreated a123456_sha123456 a123456 c123456 sha123456 - path: \Device\HarddiskVolume3\Users\admin\Downloads\hamuzim\netcat-1.11\nc.exe
filename: nc.exe
state: quarantineddeleted values: ldt:a123456:456789 INSTANCE-1 admin 2023-03-06T13:47:30Z 2022-12-13T14:23:49Z
cs-falcon-apply-quarantine-file-action
Apply action to quarantined files by file IDs or filter.
Base Command
cs-falcon-apply-quarantine-file-action
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of quarantined file IDs to update. | Optional |
| action | Action to perform against the quarantined file. Possible values are: delete, release, unrelease. | Required |
| comment | Comment to appear along with the action taken. | Required |
| filter | Update files based on a custom filter. | Optional |
| sha256 | A comma-separated list of quarantined SHA256 files to update. | Optional |
| filename | A comma-separated list of quarantined filenames to update. | Optional |
| state | Update files based on the state. | Optional |
| hostname | A comma-separated list of quarantined file hostnames to update. | Optional |
| username | A comma-separated list of quarantined file usernames to update. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-apply-quarantine-file-action filename=nc.exe action=delete comment=demo-comment
Human Readable Output
The Quarantined File with IDs [‘a123456_sha123456’] was successfully updated.
cs-falcon-ods-query-scan
Retrieve ODS scan details.
Base Command
cs-falcon-ods-query-scan
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Valid CS-Falcon-FQL filter to query with. | Optional |
| ids | Comma-separated list of scan IDs to retrieve details about. If set, will override all other arguments. | Optional |
| initiated_from | Comma-separated list of scan initiation sources to filter by. | Optional |
| status | Comma-separated list of scan statuses to filter by. | Optional |
| severity | Comma-separated list of scan severities to filter by. | Optional |
| scan_started_on | UTC-format of the scan start time to filter by. | Optional |
| scan_completed_on | UTC-format of the scan completion time to filter by. | Optional |
| offset | Starting index of overall result set from which to return IDs. | Optional |
| limit | Maximum number of resources to return. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.ODSScan.id | String | A unique identifier for the scan event. |
| CrowdStrike.ODSScan.cid | String | A unique identifier for the client that triggered the scan. |
| CrowdStrike.ODSScan.profile_id | String | A unique identifier for the scan profile used in the scan. |
| CrowdStrike.ODSScan.description | String | The ID of the description of the scan. |
| CrowdStrike.ODSScan.scan_inclusions | String | The files or folders included in the scan. |
| CrowdStrike.ODSScan.initiated_from | String | The source of the scan initiation. |
| CrowdStrike.ODSScan.quarantine | Boolean | Whether the scan was set to quarantine. |
| CrowdStrike.ODSScan.cpu_priority | Number | The CPU priority for the scan (1-5). |
| CrowdStrike.ODSScan.preemption_priority | Number | The preemption priority for the scan. |
| CrowdStrike.ODSScan.metadata.host_id | String | A unique identifier for the host that was scanned. |
| CrowdStrike.ODSScan.metadata.host_scan_id | String | A unique identifier for the scan that was performed on the host. |
| CrowdStrike.ODSScan.metadata.scan_host_metadata_id | String | A unique identifier for the metadata associated with the host scan. |
| CrowdStrike.ODSScan.metadata.filecount.scanned | Number | The number of files that were scanned. |
| CrowdStrike.ODSScan.metadata.filecount.malicious | Number | The number of files that were identified as malicious. |
| CrowdStrike.ODSScan.metadata.filecount.quarantined | Number | The number of files that were quarantined. |
| CrowdStrike.ODSScan.metadata.filecount.skipped | Number | The number of files that were skipped during the scan. |
| CrowdStrike.ODSScan.metadata.filecount.traversed | Number | The number of files that were traversed during the scan. |
| CrowdStrike.ODSScan.metadata.status | String | The status of the scan on this host. (e.g., “pending”, “running”, “completed”, or “failed”). |
| CrowdStrike.ODSScan.metadata.started_on | Date | The date and time that the scan started. |
| CrowdStrike.ODSScan.metadata.completed_on | Date | The date and time that the scan completed. |
| CrowdStrike.ODSScan.metadata.last_updated | Date | The date and time that the metadata was last updated. |
| CrowdStrike.ODSScan.status | String | The status of the scan (e.g., “pending”, “running”, “completed”, or “failed”). |
| CrowdStrike.ODSScan.hosts | String | A list of the host IDs that were scanned. |
| CrowdStrike.ODSScan.endpoint_notification | Boolean | Indicates whether endpoint notifications are enabled. |
| CrowdStrike.ODSScan.pause_duration | Number | The number of hours to pause between scanning each file. |
| CrowdStrike.ODSScan.max_duration | Number | The maximum amount of time to allow for the scan job in hours. |
| CrowdStrike.ODSScan.max_file_size | Number | The maximum file size (in MB) to scan. |
| CrowdStrike.ODSScan.sensor_ml_level_detection | Number | The level of detection sensitivity for the local sensor machine learning model. |
| CrowdStrike.ODSScan.sensor_ml_level_prevention | Number | The level of prevention sensitivity for the local sensor machine learning model. |
| CrowdStrike.ODSScan.cloud_ml_level_detection | Number | The level of detection sensitivity for the cloud machine learning model. |
| CrowdStrike.ODSScan.cloud_ml_level_prevention | Number | The level of prevention sensitivity for the cloud machine learning model. |
| CrowdStrike.ODSScan.policy_setting | Number | A list of policy setting IDs for the scan job (these correspond to specific policy settings in the Falcon console). |
| CrowdStrike.ODSScan.scan_started_on | Date | The timestamp when the scan was started. |
| CrowdStrike.ODSScan.scan_completed_on | Date | The timestamp when the scan was completed. |
| CrowdStrike.ODSScan.created_on | Date | The timestamp when the scan was created. |
| CrowdStrike.ODSScan.created_by | String | The ID of the user who created the scan job. |
| CrowdStrike.ODSScan.last_updated | Date | The timestamp when the scan job was last updated. |
Command Example
!cs-falcon-ods-query-scan initiated_from=some_admin_name severity=high scan_started_on=2023-02-27T09:51:33.91608286Z
Context Example
{
"CrowdStrike": {
"ODSScan": [
{
"cid": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"cloud_ml_level_detection": 4,
"cloud_ml_level_prevention": 4,
"cpu_priority": 5,
"created_by": "someone@email.com",
"created_on": "2023-05-03T08:45:41.688556439Z",
"endpoint_notification": true,
"file_paths": [
"C:\\Users\\admin\\Downloads\\hamuzim\\netcat-1.11\\eicar_com.exe"
],
"filecount": {},
"hosts": [
"a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
],
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"initiated_from": "some_admin_name",
"last_updated": "2023-05-03T08:45:43.348230927Z",
"max_duration": 0,
"max_file_size": 60,
"metadata": [
{
"completed_on": "2023-05-03T08:45:43.274953782Z",
"filecount": {
"malicious": 0,
"quarantined": 0,
"scanned": 0,
"skipped": 0,
"traversed": 0
},
"host_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"host_scan_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"last_updated": "2023-05-03T08:45:43.61797613Z",
"scan_host_metadata_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"started_on": "2023-05-03T08:45:43.069273028Z",
"status": "completed"
}
],
"pause_duration": 2,
"policy_setting": [
26439818675190,
26405458936832,
26405458936833,
26405458936834,
26405458936835,
26405458936840,
26405458936841,
26405458936842,
26405458936843,
26456998543793,
26456998544045,
26456998543652,
26456998543653,
26456998543656,
26456998543654,
26456998543950,
26456998543963
],
"preemption_priority": 1,
"profile_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"quarantine": true,
"scan_completed_on": "2023-05-03T08:45:43.274953782Z",
"scan_inclusions": [
"**\\Downloads\\**"
],
"scan_started_on": "2023-02-27T09:51:33.91608286Z",
"sensor_ml_level_detection": 4,
"sensor_ml_level_prevention": 4,
"status": "completed"
},
{
"cid": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"cloud_ml_level_detection": 3,
"cloud_ml_level_prevention": 3,
"cpu_priority": 4,
"created_by": "someone@email.com",
"created_on": "2023-03-12T14:54:43.659773852Z",
"endpoint_notification": true,
"filecount": {},
"hosts": [
"a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
],
"id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"initiated_from": "some_admin_name",
"last_updated": "2023-04-05T16:56:14.972317443Z",
"max_duration": 2,
"max_file_size": 60,
"metadata": [
{
"completed_on": "2023-03-12T14:57:37.338506965Z",
"filecount": {
"malicious": 0,
"quarantined": 0,
"scanned": 0,
"skipped": 0,
"traversed": 518485
},
"host_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"host_scan_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"last_updated": "2023-03-12T14:57:37.338585331Z",
"scan_host_metadata_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"started_on": "2023-02-27T09:51:33.91608286Z",
"status": "completed"
}
],
"pause_duration": 2,
"policy_setting": [
26439818674573,
26439818674574,
26439818674575,
26405458936832,
26456998543653,
26456998543656,
26456998543654,
26456998543950,
26456998543963
],
"preemption_priority": 1,
"profile_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"quarantine": true,
"scan_completed_on": "2023-03-12T14:57:37.338506965Z",
"scan_inclusions": [
"*"
],
"scan_started_on": "2023-03-12T14:54:45.210172175Z",
"sensor_ml_level_detection": 3,
"sensor_ml_level_prevention": 3,
"status": "failed"
}
]
}
}
Human Readable Output
CrowdStrike Falcon ODS Scans
ID Status Severity File Count Description Hosts/Host groups End time Start time Run by a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 failed scanned: 0
malicious: 0
quarantined: 0
skipped: 0
traversed: 518464desc3456346 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2023-02-27T09:51:33.91608286Z a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 failed scanned: 0
malicious: 0
quarantined: 0
skipped: 0
traversed: 518511a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2023-03-13T14:50:26.259846586Z 2023-02-27T09:51:33.91608286Z someone@email.com
cs-falcon-ods-query-scheduled-scan
Retrieve ODS scheduled scan details.
Base Command
cs-falcon-ods-query-scheduled-scan
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Valid CS-Falcon-FQL filter to query with. | Optional |
| ids | Comma-separated list of scan IDs to retrieve details about. If set, will override all other arguments. | Optional |
| initiated_from | Comma-separated list of scan initiation sources to filter by. | Optional |
| status | Comma-separated list of scan statuses to filter by. | Optional |
| created_on | UTC-format of the scan creation time to filter by. | Optional |
| created_by | UTC-format time of the scan creator to filter by. | Optional |
| start_timestamp | UTC-format of scan start time to filter by. | Optional |
| deleted | Deleted scans only. | Optional |
| offset | Starting index of overall result set from which to return IDs. | Optional |
| limit | Maximum number of resources to return. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.ODSScheduledScan.id | String | Unique identifier for the scan. |
| CrowdStrike.ODSScheduledScan.cid | String | Identifier for the customer or organization that owns the scan. |
| CrowdStrike.ODSScheduledScan.description | String | The ID of the description of the scan. |
| CrowdStrike.ODSScheduledScan.file_paths | String | The file or folder paths scanned. |
| CrowdStrike.ODSScheduledScan.scan_exclusions | String | The file or folder exclusions from the scan. |
| CrowdStrike.ODSScheduledScan.initiated_from | String | The source of the scan initiation. |
| CrowdStrike.ODSScheduledScan.cpu_priority | Number | The CPU priority for the scan (1-5). |
| CrowdStrike.ODSScheduledScan.preemption_priority | Number | The preemption priority for the scan. |
| CrowdStrike.ODSScheduledScan.status | String | The status of the scan, whether it’s “scheduled”, “running”, “completed”, etc. |
| CrowdStrike.ODSScheduledScan.host_groups | String | The host groups targeted by the scan. |
| CrowdStrike.ODSScheduledScan.endpoint_notification | Boolean | Whether notifications of the scan were sent to endpoints. |
| CrowdStrike.ODSScheduledScan.pause_duration | Number | The pause duration of the scan in hours. |
| CrowdStrike.ODSScheduledScan.max_duration | Number | The maximum duration of the scan in hours. |
| CrowdStrike.ODSScheduledScan.max_file_size | Number | The maximum file size that the scan can handle in MB. |
| CrowdStrike.ODSScheduledScan.sensor_ml_level_detection | Number | The machine learning detection level for the sensor. |
| CrowdStrike.ODSScheduledScan.cloud_ml_level_detection | Number | The machine learning detection level for the cloud. |
| CrowdStrike.ODSScheduledScan.schedule.start_timestamp | Date | The timestamp when the first scan was created. |
| CrowdStrike.ODSScheduledScan.schedule.interval | Number | The interval between scans. |
| CrowdStrike.ODSScheduledScan.created_on | Date | The timestamp when the scan was created. |
| CrowdStrike.ODSScheduledScan.created_by | String | The user who created the scan. |
| CrowdStrike.ODSScheduledScan.last_updated | Date | The timestamp when the scan was last updated. |
| CrowdStrike.ODSScheduledScan.deleted | Boolean | Whether the scan was deleted. |
| CrowdStrike.ODSScheduledScan.quarantine | Boolean | Whether the scan was set to quarantine. |
| CrowdStrike.ODSScheduledScan.metadata.host_id | String | Scan host IDs. |
| CrowdStrike.ODSScheduledScan.metadata.last_updated | Date | The date and time when the detection event was last updated. |
| CrowdStrike.ODSScheduledScan.sensor_ml_level_prevention | Number | The machine learning prevention level for the sensor. |
| CrowdStrike.ODSScheduledScan.cloud_ml_level_prevention | Number | The machine learning prevention level for the cloud. |
Command Example
!cs-falcon-ods-query-scheduled-scan ids=123456789
Context Example
{
"CrowdStrike": {
"ODSScheduledScan": {
"cid": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"cloud_ml_level_detection": 2,
"cloud_ml_level_prevention": 2,
"cpu_priority": 3,
"created_by": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"created_on": "2023-05-08T09:04:20.8414225Z",
"deleted": false,
"endpoint_notification": true,
"host_groups": [
"a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
],
"id": "123456789",
"initiated_from": "cloud_scheduled",
"last_updated": "2023-05-08T09:22:48.408487143Z",
"max_duration": 2,
"max_file_size": 60,
"metadata": [
{
"host_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"last_updated": "2023-05-08T09:22:48.408487143Z"
}
],
"pause_duration": 3,
"policy_setting": [
26439818674573,
26439818674574,
26439818675074,
26405458936702,
26405458936703,
26405458936707,
26439818675124,
26439818675125,
26439818675157,
26439818675158,
26439818675182,
26439818675183,
26439818675190,
26439818675191,
26439818675196,
26439818675197,
26439818675204,
26439818675205,
26405458936760,
26405458936761,
26405458936793,
26405458936794,
26405458936818,
26405458936819,
26405458936825,
26405458936826,
26405458936832,
26405458936833,
26405458936840,
26405458936841,
26456998543793,
26456998544045,
26456998543652,
26456998543653,
26456998543656,
26456998543654,
26456998543950,
26456998543963
],
"preemption_priority": 15,
"quarantine": true,
"scan_inclusions": [
"*"
],
"schedule": {
"interval": 14,
"start_timestamp": "2023-05-20T06:49"
},
"sensor_ml_level_detection": 2,
"sensor_ml_level_prevention": 2,
"status": "scheduled"
}
}
}
Human Readable Output
CrowdStrike Falcon ODS Scheduled Scans
ID Hosts targeted Description Host groups Start time Created by 123456789 1 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 2023-05-20T06:49 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1
cs-falcon-ods-query-scan-host
Retrieve ODS scan host details.
Base Command
cs-falcon-ods-query-scan-host
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Valid CS-Falcon-FQL filter to query with. | Optional |
| host_ids | Comma-separated list of host IDs to filter by. | Optional |
| scan_ids | Comma-separated list of scan IDs to filter by. | Optional |
| status | Comma-separated list of scan statuses to filter by. | Optional |
| started_on | UTC-format of scan start time to filter by. | Optional |
| completed_on | UTC-format of scan completion time to filter by. | Optional |
| offset | Starting index of the overall result set from which to return IDs. | Optional |
| limit | Maximum number of resources to return. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.ODSScanHost.id | String | A unique identifier for the scan event. |
| CrowdStrike.ODSScanHost.cid | String | A unique identifier for the client that triggered the scan. |
| CrowdStrike.ODSScanHost.scan_id | String | A unique identifier for the scan. |
| CrowdStrike.ODSScanHost.profile_id | String | A unique identifier for the scan profile used in the scan. |
| CrowdStrike.ODSScanHost.host_id | String | A unique identifier for the host that was scanned. |
| CrowdStrike.ODSScanHost.host_scan_id | String | A unique identifier for the scan that was performed on the host. |
| CrowdStrike.ODSScanHost.filecount.scanned | Number | The number of files that were scanned during the scan. |
| CrowdStrike.ODSScanHost.filecount.malicious | Number | The number of files that were detected as malicious during the scan. |
| CrowdStrike.ODSScanHost.filecount.quarantined | Number | The number of files that were quarantined during the scan. |
| CrowdStrike.ODSScanHost.filecount.skipped | Number | The number of files that were skipped during the scan. |
| CrowdStrike.ODSScanHost.status | String | The status of the scan. (e.g., “completed”, “pending”, “cancelled”, “running”, or “failed”). |
| CrowdStrike.ODSScanHost.severity | Number | A severity score assigned to the scan, ranging from 0 to 100. |
| CrowdStrike.ODSScanHost.started_on | Date | The date and time when the scan started. |
| CrowdStrike.ODSScanHost.completed_on | Date | The date and time when the scan completed. |
| CrowdStrike.ODSScanHost.last_updated | Date | The date and time when the scan event was last updated. |
Command Example
!cs-falcon-ods-query-scan-host filter="scan_id:[\"123456789\",\"987654321\"]"
Context Example
{
"CrowdStrike": {
"ODSScanHost": [
{
"cid": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"filecount": {},
"host_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"id": "123456789",
"last_updated": "2022-11-27T17:15:50.056840267Z",
"profile_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"scan_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"status": "pending"
},
{
"cid": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"completed_on": "2023-05-07T08:28:56.856506979Z",
"filecount": {
"malicious": 0,
"quarantined": 0,
"scanned": 0,
"skipped": 0,
"traversed": 524581
},
"host_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"host_scan_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"id": "987654321",
"last_updated": "2023-05-07T08:28:56.856575358Z",
"profile_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"scan_id": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
"started_on": "2023-05-07T08:25:48.336234188Z",
"status": "completed"
}
]
}
}
Human Readable Output
CrowdStrike Falcon ODS Scan Hosts
ID Scan ID Host ID Filecount Status Severity Started on 123456789 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 pending 987654321 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1 scanned: 0
malicious: 0
quarantined: 0
skipped: 0
traversed: 524581completed 2023-05-07T08:25:48.336234188Z
cs-falcon-ods-query-malicious-files
Retrieve ODS malicious file details.
Base Command
cs-falcon-ods-query-malicious-files
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Valid CS-Falcon-FQL filter to query with. | Optional |
| file_ids | Comma-separated list of malicious file IDs to retrieve details about. If set, will override all other arguments. | Optional |
| host_ids | Comma-separated list of host IDs to filter by. | Optional |
| scan_ids | Comma-separated list of scan IDs to filter by. | Optional |
| file_paths | Comma-separated list of file paths to filter by. | Optional |
| file_names | Comma-separated list of filenames to filter by. | Optional |
| hash | Comma-separated list of hashes to filter by. | Optional |
| offset | Starting index of the overall result set from which to return IDs. | Optional |
| limit | Maximum number of resources to return. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.ODSMaliciousFile.id | String | A unique identifier of the detection event. |
| CrowdStrike.ODSMaliciousFile.cid | String | A unique identifier for the client that triggered the detection event. |
| CrowdStrike.ODSMaliciousFile.scan_id | String | A unique identifier for the scan that triggered the detection event. |
| CrowdStrike.ODSMaliciousFile.host_id | String | A unique identifier for the host that was scanned. |
| CrowdStrike.ODSMaliciousFile.host_scan_id | String | A unique identifier for the scan that detected the file on the host. |
| CrowdStrike.ODSMaliciousFile.filepath | String | The full path to the malicious file on the host system. |
| CrowdStrike.ODSMaliciousFile.filename | String | The name of the malicious file. |
| CrowdStrike.ODSMaliciousFile.hash | String | A SHA256 hash of the malicious file, which can be used to identify it. |
| CrowdStrike.ODSMaliciousFile.pattern_id | Number | The identifier of the pattern used to detect the malicious file. |
| CrowdStrike.ODSMaliciousFile.severity | Number | A severity score assigned to the detection event, ranging from 0 to 100. |
| CrowdStrike.ODSMaliciousFile.quarantined | Boolean | Indicates whether the file was quarantined. |
| CrowdStrike.ODSMaliciousFile.last_updated | Date | The date and time when the detection event was last updated. |
Command Example
#### Human Readable Output
>No malicious files match the arguments/filter.
### cs-falcon-ods-create-scan
***
Create an ODS scan and wait for the results.
#### Base Command
`cs-falcon-ods-create-scan`
#### Input
| **Argument Name** | **Description** | **Required** |
| --- | --- | --- |
| hosts | A comma-separated list of hosts to be scanned. "hosts" OR "host_groups" must be set. | Optional |
| host_groups | A comma-separated list of host groups to be scanned. "hosts" OR "host_groups" must be set. | Optional |
| file_paths | A comma-separated list of file paths to be scanned. "file_paths" OR "scan_inclusions" must be set. | Optional |
| scan_inclusions | A comma-separated list of included files or locations for this scan. "file_paths" OR "scan_inclusions" must be set. | Optional |
| scan_exclusions | A comma-separated list of excluded files or locations for this scan. | Optional |
| initiated_from | Scan origin. | Optional |
| cpu_priority | The scan CPU priority. Possible values are: Highest, High, Medium, Low, Lowest. Default is Low. | Optional |
| description | Scan description. | Optional |
| quarantine | Flag indicating if identified threats should be quarantined. | Optional |
| pause_duration | Amount of time (in hours) for scan pauses. Default is 2. | Optional |
| sensor_ml_level_detection | Sensor ML detection level. | Optional |
| sensor_ml_level_prevention | Sensor ML prevention level. | Optional |
| cloud_ml_level_detection | Cloud ML detection level for the scan. | Optional |
| cloud_ml_level_prevention | Cloud ML prevention level for the scan. | Optional |
| max_duration | Maximum time (in hours) the scan is allowed to execute. Default is 2. | Optional |
| interval_in_seconds | The interval in seconds between each poll. Default is 30. | Optional |
| timeout_in_seconds | The timeout in seconds until polling ends. Default is 600. | Optional |
| cloud_pup_adware_level_detection | Potentially unwanted programs (PUPs) adware detection level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled). Possible values are: 0, 1, 2, 3, 4. | Optional |
| cloud_pup_adware_level_prevention | Potentially unwanted programs (PUPs) adware prevention level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled). Possible values are: 0, 1, 2, 3, 4. | Optional |
| polling | Whether to use polling to wait for the scan result. If set to false, the command will only create the scan and return immediately without waiting for results. Possible values are: true, false. Default is true. | Optional |
#### Context Output
| **Path** | **Type** | **Description** |
| --- | --- | --- |
| CrowdStrike.ODSScan.id | String | A unique identifier for the scan event. |
| CrowdStrike.ODSScan.cid | String | A unique identifier for the client that triggered the scan. |
| CrowdStrike.ODSScan.profile_id | String | A unique identifier for the scan profile used in the scan. |
| CrowdStrike.ODSScan.description | String | The ID of the description of the scan. |
| CrowdStrike.ODSScan.scan_inclusions | String | The files or folders included in the scan. |
| CrowdStrike.ODSScan.initiated_from | String | The source of the scan initiation. |
| CrowdStrike.ODSScan.quarantine | Boolean | Whether the scan was set to quarantine. |
| CrowdStrike.ODSScan.cpu_priority | Number | The CPU priority for the scan \(1-5\). |
| CrowdStrike.ODSScan.preemption_priority | Number | The preemption priority for the scan. |
| CrowdStrike.ODSScan.metadata.host_id | String | A unique identifier for the host that was scanned. |
| CrowdStrike.ODSScan.metadata.host_scan_id | String | A unique identifier for the scan that was performed on the host. |
| CrowdStrike.ODSScan.metadata.scan_host_metadata_id | String | A unique identifier for the metadata associated with the host scan. |
| CrowdStrike.ODSScan.metadata.filecount.scanned | Number | The number of files that were scanned. |
| CrowdStrike.ODSScan.metadata.filecount.malicious | Number | The number of files that were identified as malicious. |
| CrowdStrike.ODSScan.metadata.filecount.quarantined | Number | The number of files that were quarantined. |
| CrowdStrike.ODSScan.metadata.filecount.skipped | Number | The number of files that were skipped during the scan. |
| CrowdStrike.ODSScan.metadata.filecount.traversed | Number | The number of files that were traversed during the scan. |
| CrowdStrike.ODSScan.metadata.status | String | The status of the scan on this host \(e.g., "pending", "running", "completed", or "failed"\). |
| CrowdStrike.ODSScan.metadata.started_on | Date | The date and time that the scan started. |
| CrowdStrike.ODSScan.metadata.completed_on | Date | The date and time that the scan completed. |
| CrowdStrike.ODSScan.metadata.last_updated | Date | The date and time that the metadata was last updated. |
| CrowdStrike.ODSScan.status | String | The status of the scan \(e.g., "pending", "running", "completed", or "failed"\). |
| CrowdStrike.ODSScan.hosts | String | A list of the host IDs that were scanned. |
| CrowdStrike.ODSScan.endpoint_notification | Boolean | Indicates whether endpoint notifications are enabled. |
| CrowdStrike.ODSScan.pause_duration | Number | The number of hours to pause between scanning each file. |
| CrowdStrike.ODSScan.max_duration | Number | The maximum amount of time to allow for the scan job in hours. |
| CrowdStrike.ODSScan.max_file_size | Number | The maximum file size \(in MB\) to scan. |
| CrowdStrike.ODSScan.sensor_ml_level_detection | Number | The level of detection sensitivity for the local sensor machine learning model. |
| CrowdStrike.ODSScan.sensor_ml_level_prevention | Number | The level of prevention sensitivity for the local sensor machine learning model. |
| CrowdStrike.ODSScan.cloud_ml_level_detection | Number | The level of detection sensitivity for the cloud machine learning model. |
| CrowdStrike.ODSScan.cloud_ml_level_prevention | Number | The level of prevention sensitivity for the cloud machine learning model. |
| CrowdStrike.ODSScan.policy_setting | Number | A list of policy setting IDs for the scan job \(these correspond to specific policy settings in the Falcon console\). |
| CrowdStrike.ODSScan.scan_started_on | Date | The timestamp when the scan was started. |
| CrowdStrike.ODSScan.scan_completed_on | Date | The timestamp when the scan was completed. |
| CrowdStrike.ODSScan.created_on | Date | The timestamp when the scan was created. |
| CrowdStrike.ODSScan.created_by | String | The ID of the user who created the scan job. |
| CrowdStrike.ODSScan.last_updated | Date | The timestamp when the scan job was last updated. |
| CrowdStrike.ODSScan.cloud_pup_adware_level_detection | Number | Potentially unwanted programs \(PUPs\) Adware detection level. |
| CrowdStrike.ODSScan.cloud_pup_adware_level_prevention | Number | Potentially unwanted programs \(PUPs\) Adware prevention level. |
#### Command Example
```!cs-falcon-ods-create-scan host_groups=7471ba0636b34cbb8c65fae7979a6a9b scan_inclusions=* cpu_priority=Highest max_duration=1 pause_duration=1```
#### Context Example
```json
{
"CrowdStrike": {
"ODSScan": {
"cid": "20879a8064904ecfbb62c118a6a19411",
"cloud_ml_level_detection": 2,
"cloud_ml_level_prevention": 2,
"cpu_priority": 5,
"created_by": "f7acf1bd5d3d4b40afe77546cbbaefde",
"created_on": "2023-06-11T13:23:05.139153881Z",
"filecount": {
"malicious": 0,
"quarantined": 0,
"scanned": 0,
"skipped": 0,
"traversed": 0
},
"host_groups": [
"7471ba0636b34cbb8c65fae7979a6a9b"
],
"id": "9ba8489e9f604b61bf9b4a2c5f95ede7",
"initiated_from": "cloud_adhoc",
"last_updated": "2023-06-11T13:23:05.139153881Z",
"max_duration": 1,
"max_file_size": 60,
"metadata": [
{
"filecount": {},
"host_id": "046761c46ec84f40b27b6f79ce7cd32c",
"last_updated": "2023-06-11T13:23:05.139153881Z",
"scan_host_metadata_id": "31052e821a5a4189a1a9a2814cc88e4e",
"status": "complete"
}
],
"pause_duration": 1,
"policy_setting": [
26439818674573,
26439818674574,
26439818675074,
26405458936702,
26405458936703,
26456998543654,
26456998543950,
26456998543963
],
"preemption_priority": 1,
"profile_id": "335198a96e1a4a6b880d62b2e7ccbb91",
"quarantine": true,
"scan_inclusions": [
"*"
],
"sensor_ml_level_detection": 2,
"sensor_ml_level_prevention": 2,
"cloud_pup_adware_level_prevention": 1,
"cloud_pup_adware_level_detection": 1,
"status": "complete"
}
}
}
Human Readable Output
CrowdStrike Falcon ODS Scans
ID Status Severity File Count Description Hosts/Host groups End time Start time Run by 9ba8489e9f604b61bf9b4a2c5f95ede7 complete 7471ba0636b34cbb8c65fae7979a6a9b f7acf1bd5d3d4b40afe77546cbbaefde
cs-falcon-ods-create-scheduled-scan
Create an ODS scheduled scan.
Base Command
cs-falcon-ods-create-scheduled-scan
Input
| Argument Name | Description | Required |
|---|---|---|
| host_groups | A comma-separated list of host groups to be scanned. | Required |
| file_paths | A comma-separated list of file paths to be scanned. “file_paths” OR “scan_inclusions” must be set. | Optional |
| scan_inclusions | A comma-separated list of included files or locations for this scan. “file_paths” OR “scan_inclusions” must be set. | Optional |
| scan_exclusions | A comma-separated list of excluded files or locations for this scan. | Optional |
| initiated_from | Scan origin. | Optional |
| cpu_priority | The scan CPU priority. Possible values are: Highest, High, Medium, Low, Lowest. Default is Low. | Optional |
| description | Scan description. | Optional |
| quarantine | Flag indicating if identified threats should be quarantined. | Optional |
| pause_duration | Amount of time (in hours) for scan pauses. Default is 2. | Optional |
| sensor_ml_level_detection | Sensor ML detection level. | Optional |
| sensor_ml_level_prevention | Sensor ML prevention level. | Optional |
| cloud_ml_level_detection | Cloud ML detection level for the scan. | Optional |
| cloud_ml_level_prevention | Cloud ML prevention level for the scan. | Optional |
| max_duration | Maximum time (in hours) the scan is allowed to execute. Default is 2. | Optional |
| schedule_start_timestamp | When to start the first scan. Supports english expressions such as “tomorrow” or “in an hour”. | Required |
| schedule_interval | The schedule interval. Possible values are: Never, Daily, Weekly, Every other week, Every four weeks, Monthly. | Required |
| cloud_pup_adware_level_detection | Potentially unwanted programs (PUPs) adware detection level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled). Possible values are: 0, 1, 2, 3, 4. | Optional |
| cloud_pup_adware_level_prevention | Potentially unwanted programs (PUPs) adware prevention level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled). Possible values are: 0, 1, 2, 3, 4. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.ODSScheduledScan.id | String | Unique identifier for the scan. |
| CrowdStrike.ODSScheduledScan.cid | String | Identifier for the customer or organization that owns the scan. |
| CrowdStrike.ODSScheduledScan.description | String | The ID of the description of the scan. |
| CrowdStrike.ODSScheduledScan.file_paths | String | The file or folder paths scanned. |
| CrowdStrike.ODSScheduledScan.scan_exclusions | String | The file or folder exclusions from the scan. |
| CrowdStrike.ODSScheduledScan.initiated_from | String | The source of the scan initiation. |
| CrowdStrike.ODSScheduledScan.cpu_priority | Number | The CPU priority for the scan (1-5). |
| CrowdStrike.ODSScheduledScan.preemption_priority | Number | The preemption priority for the scan. |
| CrowdStrike.ODSScheduledScan.status | String | The status of the scan, whether it’s “scheduled”, “running”, “completed”, etc. |
| CrowdStrike.ODSScheduledScan.host_groups | String | The host groups targeted by the scan. |
| CrowdStrike.ODSScheduledScan.endpoint_notification | Boolean | Whether notifications of the scan were sent to endpoints. |
| CrowdStrike.ODSScheduledScan.pause_duration | Number | The pause duration of the scan in hours. |
| CrowdStrike.ODSScheduledScan.max_duration | Number | The maximum duration of the scan in hours. |
| CrowdStrike.ODSScheduledScan.max_file_size | Number | The maximum file size that the scan can handle in MB. |
| CrowdStrike.ODSScheduledScan.sensor_ml_level_detection | Number | The machine learning detection level for the sensor. |
| CrowdStrike.ODSScheduledScan.cloud_ml_level_detection | Number | The machine learning detection level for the cloud. |
| CrowdStrike.ODSScheduledScan.schedule.start_timestamp | Date | The timestamp when the first scan was created. |
| CrowdStrike.ODSScheduledScan.schedule.interval | Number | The interval between scans. |
| CrowdStrike.ODSScheduledScan.created_on | Date | The timestamp when the scan was created. |
| CrowdStrike.ODSScheduledScan.created_by | String | The user who created the scan. |
| CrowdStrike.ODSScheduledScan.last_updated | Date | The timestamp when the scan was last updated. |
| CrowdStrike.ODSScheduledScan.deleted | Boolean | Whether the scan was deleted. |
| CrowdStrike.ODSScheduledScan.quarantine | Boolean | Whether the scan was set to quarantine. |
| CrowdStrike.ODSScheduledScan.metadata.host_id | String | Scan host IDs. |
| CrowdStrike.ODSScheduledScan.metadata.last_updated | Date | The date and time when the detection event was last updated. |
| CrowdStrike.ODSScheduledScan.sensor_ml_level_prevention | Number | The machine learning prevention level for the sensor. |
| CrowdStrike.ODSScheduledScan.cloud_ml_level_prevention | Number | The machine learning prevention level for the cloud. |
| CrowdStrike.ODSScheduledScan.cloud_pup_adware_level_detection | Number | Potentially unwanted programs (PUPs) Adware detection level. |
| CrowdStrike.ODSScheduledScan.cloud_pup_adware_level_prevention | Number | Potentially unwanted programs (PUPs) Adware prevention level. |
Command Example
!cs-falcon-ods-create-scheduled-scan host_groups=7471ba0636b34cbb8c65fae7979a6a9b schedule_interval=daily schedule_start_timestamp=tomorrow cpu_priority=Highest scan_inclusions=*
Context Example
{
"CrowdStrike": {
"ODSScan": {
"cid": "20879a8064904ecfbb62c118a6a19411",
"cloud_ml_level_detection": 2,
"cloud_ml_level_prevention": 2,
"cpu_priority": 5,
"created_by": "f7acf1bd5d3d4b40afe77546cbbaefde",
"created_on": "2023-06-11T13:23:10.564070276Z",
"deleted": false,
"host_groups": [
"7471ba0636b34cbb8c65fae7979a6a9b"
],
"id": "7d08d9a3088f49b3aa20efafc355aef0",
"initiated_from": "cloud_scheduled",
"last_updated": "2023-06-11T13:23:10.564070276Z",
"max_duration": 2,
"max_file_size": 60,
"metadata": [
{
"host_id": "046761c46ec84f40b27b6f79ce7cd32c",
"last_updated": "2023-06-11T13:23:10.564070276Z"
}
],
"pause_duration": 2,
"policy_setting": [
26439818674573,
26439818674574,
26439818675074,
26405458936702,
26405458936703,
26405458936707,
26439818675124,
26439818675125,
26439818675157,
26439818675158,
26439818675182,
26439818675183,
26439818675190,
26439818675191,
26439818675196,
26439818675197,
26439818675204,
26439818675205,
26405458936760,
26405458936761,
26405458936793,
26405458936794,
26405458936818,
26405458936819,
26405458936825,
26405458936826,
26405458936832,
26405458936833,
26405458936840,
26405458936841,
26456998543793,
26456998544045,
26456998543652,
26456998543653,
26456998543656,
26456998543654,
26456998543950,
26456998543963
],
"preemption_priority": 15,
"quarantine": true,
"scan_inclusions": [
"*"
],
"schedule": {
"interval": 1,
"start_timestamp": "2023-06-12T13:23"
},
"sensor_ml_level_detection": 2,
"sensor_ml_level_prevention": 2,
"cloud_pup_adware_level_prevention": 1,
"cloud_pup_adware_level_detection": 1,
"status": "scheduled"
}
}
}
Human Readable Output
Scheduled Scan Created
Scan ID 7d08d9a3088f49b3aa20efafc355aef0
cs-falcon-ods-delete-scheduled-scan
Delete ODS scheduled scans.
Base Command
cs-falcon-ods-delete-scheduled-scan
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | Comma-separated list of scheduled scan IDs to delete. | Optional |
| filter | Valid CS-Falcon-FQL filter to delete scans by. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-ods-delete-scheduled-scan ids=9acf0c069d3d4a5b82badb170966e77c
Human Readable Output
Deleted Scans
Scan ID 9acf0c069d3d4a5b82badb170966e77c
cs-falcon-list-identity-entities
List identity entities.
Base Command
cs-falcon-list-identity-entities
Input
| Argument Name | Description | Required |
|---|---|---|
| type | API type. Possible values are: USER, ENDPOINT. | Required |
| sort_key | The key to sort by. Possible values are: RISK_SCORE, PRIMARY_DISPLAY_NAME, SECONDARY_DISPLAY_NAME, MOST_RECENT_ACTIVITY, ENTITY_ID. | Optional |
| sort_order | The sort order. Possible values are: DESCENDING, ASCENDING. Default is ASCENDING. | Optional |
| entity_id | A comma-separated list of entity IDs to look for. | Optional |
| primary_display_name | A comma-separated list of primary display names to filter by. | Optional |
| secondary_display_name | A comma-separated list of secondary display names to filter by. | Optional |
| max_risk_score_severity | The maximum risk score severity to filter by. Possible values are: NORMAL, MEDIUM, HIGH. | Optional |
| min_risk_score_severity | The minimum risk score severity to filter by. Possible values are: NORMAL, MEDIUM, HIGH. | Optional |
| enabled | Whether to get only enabled or disabled identity entities. Possible values are: true, false. | Optional |
| Email to filter by. | Optional | |
| next_token | The hash for the next page. | Optional |
| page_size | The maximum number of items to fetch per page. The maximum value allowed is 1000. Default is 50. | Optional |
| page | The page number. Default is 1. | Optional |
| limit | The maximum number of identity entities to list. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IDPEntity.Ishuman | Boolean | Whether the identity entity is human made. |
| CrowdStrike.IDPEntity.Isprogrammatic | Boolean | Whether the identity entity is programmatic made. |
| CrowdStrike.IDPEntity.Isadmin | String | Whether the identity entity is admin made. |
| CrowdStrike.IDPEntity.Primarydisplayname | String | The identity entity primary display name. |
| CrowdStrike.IDPEntity.Riskfactors.Type | Unknown | The identity entity risk factor type. |
| CrowdStrike.IDPEntity.Riskfactors.Severity | Unknown | The identity entity risk factor severity. |
| CrowdStrike.IDPEntity.Riskscore | Number | The identity entity risk score. |
| CrowdStrike.IDPEntity.Riskscoreseverity | String | The identity entity risk score severity. |
| CrowdStrike.IDPEntity.Secondarydisplayname | String | The identity entity secondary display name. |
| CrowdStrike.IDPEntity.Emailaddresses | String | The identity entity email address. |
cs-falcon-cspm-list-policy-details
Given a CSV list of policy IDs, returns detailed policy information.
Base Command
cs-falcon-cspm-list-policy-details
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_ids | Comma-separated list of policy IDs to look for. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.CSPMPolicy.ID | Integer | The policy ID. |
| CrowdStrike.CSPMPolicy.CreatedAt | Date | The creation date. |
| CrowdStrike.CSPMPolicy.UpdatedAt | Date | The update date. |
| CrowdStrike.CSPMPolicy.DeletedAt | Date | The deletion date. |
| CrowdStrike.CSPMPolicy.description | String | The policy description. |
| CrowdStrike.CSPMPolicy.policy_statement | String | The policy statement. |
| CrowdStrike.CSPMPolicy.policy_remediation | String | The policy remediation. |
| CrowdStrike.CSPMPolicy.cloud_service_subtype | String | The cloud service subtype. |
| CrowdStrike.CSPMPolicy.cloud_document | String | The cloud document. |
| CrowdStrike.CSPMPolicy.mitre_attack_cloud_matrix | String | URL to the MITRE attack tactics. |
| CrowdStrike.CSPMPolicy.mitre_attack_cloud_subtype | String | URL to the MITRE attack techniques. |
| CrowdStrike.CSPMPolicy.alert_logic | String | The alert logic. |
| CrowdStrike.CSPMPolicy.api_command | String | The API command. |
| CrowdStrike.CSPMPolicy.cli_command | String | The CLI command. |
| CrowdStrike.CSPMPolicy.cloud_platform_type | String | The cloud platform type. |
| CrowdStrike.CSPMPolicy.cloud_service_type | String | The cloud service type. |
| CrowdStrike.CSPMPolicy.default_severity | String | The default severity. |
| CrowdStrike.CSPMPolicy.cis_benchmark_ids | Array | The CIS benchmark IDs. |
| CrowdStrike.CSPMPolicy.nist_benchmark_ids | Array | The NIST benchmark IDs. |
| CrowdStrike.CSPMPolicy.pci_benchmark_ids | Array | The PCI benchmark IDs. |
| CrowdStrike.CSPMPolicy.policy_type | String | The policy type. |
| CrowdStrike.CSPMPolicy.tactic_url | String | The tactic URL. |
| CrowdStrike.CSPMPolicy.technique_url | String | The technique URL. |
| CrowdStrike.CSPMPolicy.tactic | String | The tactic used. |
| CrowdStrike.CSPMPolicy.technique | String | The technique used. |
| CrowdStrike.CSPMPolicy.tactic_id | String | The tactic ID. |
| CrowdStrike.CSPMPolicy.technique_id | String | The technique ID. |
| CrowdStrike.CSPMPolicy.attack_types | Array | The attack types. |
| CrowdStrike.CSPMPolicy.asset_type_id | Integer | The asset type ID. |
| CrowdStrike.CSPMPolicy.cloud_asset_type | String | The cloud asset type. |
| CrowdStrike.CSPMPolicy.is_remediable | Boolean | Whether the policy is remediable or not. |
| CrowdStrike.CSPMPolicy.is_enabled | Boolean | Whether the policy is enabled or not. |
| CrowdStrike.CSPMPolicy.account_scope | String | The account scope. |
Command Example
!cs-falcon-cspm-list-policy-details policy_ids=1,2
Context Example
{
"CrowdStrike": {
"CSPMPolicy": [
{
"CreatedAt": "2020-08-18T08:30:21.760579Z",
"DeletedAt": null,
"ID": 1,
"UpdatedAt": "2023-06-21T18:47:44.371539Z",
"account_scope": "",
"alert_logic": "1. List all IAM users.|\n2. Filter on users with active access keys.|\n3. Filter on access keys that have not been rotated in 90 days.|\n4. Alert on each user.",
"api_command": "ListUsers, ListAccessKeys",
"asset_type_id": 8,
"attack_types": [
"Credential policy violation"
],
"cis_benchmark_ids": [
108,
641,
740
],
"cli_command": "aws2 iam list-users, aws2 iam list-access-keys",
"cloud_asset_type": "user",
"cloud_document": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html",
"cloud_platform_type": "aws",
"cloud_service_subtype": "Access Keys",
"cloud_service_type": "IAM",
"default_severity": "informational",
"description": "Because IAM access keys are long-term credentials, as time goes on, the risk of these keys being exposed is increased.\n\nKeys are often left on old servers, accidentally published through Git, or stolen from developer machines. The longer the keys are valid, the more likely they are to be discovered in one of these places. By ensuring keys are rotated at least every 90 days, you can be confident that if those keys are discovered, they cannot be abused.",
"is_enabled": true,
"is_remediable": false,
"mitre_attack_cloud_matrix": "https://attack.mitre.org/tactics/TA0006/",
"mitre_attack_cloud_subtype": "https://attack.mitre.org/techniques/T1528/",
"nist_benchmark_ids": [
2,
3,
281,
941
],
"pci_benchmark_ids": [
120
],
"policy_remediation": "Step 1. From the AWS Console, navigate to the IAM page.|\nStep 2. Locate and click on the offending IAM User.|\nStep 3. Click on the Security Credentials tab.|\nStep 4. Navigate to the Access Keys section and choose between making the access key inactive, deleting the key, or rotating the key.",
"policy_statement": "IAM user access key active longer than 90 days",
"policy_type": "Configuration",
"tactic": "Credential Access",
"tactic_id": "TA0006",
"tactic_url": "https://attack.mitre.org/tactics/TA0006/",
"technique": "Steal Application Access Token",
"technique_id": "T1528",
"technique_url": "https://attack.mitre.org/techniques/T1528/"
},
{
"CreatedAt": "2022-10-19T15:00:00Z",
"DeletedAt": null,
"ID": 2,
"UpdatedAt": "2023-07-20T19:14:47.972998Z",
"account_scope": "",
"alert_logic": "1. List Launch Configurations.|\n2. Decode Base64-encoded User Data field.|\n3. Search for strings indicating credentials are present.|\n4. Alert on each instance.",
"api_command": "DescribeLaunchConfigurations",
"asset_type_id": 81,
"cis_benchmark_ids": [
714
],
"cisa_benchmark_ids": [
16
],
"cli_command": "aws autoscaling describe-launch-configurations",
"cloud_asset_type": "launchconfig",
"cloud_document": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html",
"cloud_platform_type": "aws",
"cloud_service_type": "Auto Scaling",
"default_severity": "informational",
"description": "EC2 instance data is used to pass start up information into the EC2 instance. This User Data must not contain any sort of credentials. Instead, use an IAM Instance Profile assigned to the instance to grant access to other AWS Services.",
"is_enabled": true,
"is_remediable": false,
"iso_benchmark_ids": [
10,
15,
62,
63
],
"mitre_attack_cloud_matrix": "https://attack.mitre.org/tactics/TA0006/",
"mitre_attack_cloud_subtype": "https://attack.mitre.org/techniques/T1552/005/",
"nist_benchmark_ids": [
16,
65,
66,
531
],
"policy_remediation": "Step 1. From the console navigate to the EC2 page.|\nStep 2. From the sub-menu, click on 'Launch Configurations' under 'Auto Scaling'.|\nStep 3. Select the offending launch configuration.|\nStep 4. Scroll down to the 'Details' section and click 'View user data'.|\nStep 5. Validate whether or not any credentials are present.|\nStep 6. If credentials are present, re-create the launch configuration without exposing any credentials in the user data field.",
"policy_statement": "Auto Scaling group launch configuration User Data with potential credentials exposed",
"policy_type": "Configuration",
"soc2_benchmark_ids": [
15,
17
],
"tactic": "Credential Access",
"tactic_id": "TA0006",
"tactic_url": "https://attack.mitre.org/tactics/TA0006/",
"technique": "Unsecured Credentials: Cloud Instance Metadata API",
"technique_id": "T1552.005",
"technique_url": "https://attack.mitre.org/techniques/T1552/005/"
}
]
}
}
Human Readable Output
CSPM Policy Details
Id Description Policy Statement Policy Remediation Cloud Service Subtype Cloud Platform Type Cloud Service Type Default Severity Policy Type Tactic Technique 1 Because IAM access keys are long-term credentials, as time goes on, the risk of these keys being exposed is increased.
Keys are often left on old servers, accidentally published through Git, or stolen from developer machines. The longer the keys are valid, the more likely they are to be discovered in one of these places. By ensuring keys are rotated at least every 90 days, you can be confident that if those keys are discovered, they cannot be abused.IAM user access key active longer than 90 days Step 1. From the AWS Console, navigate to the IAM page.|
Step 2. Locate and click on the offending IAM User.|
Step 3. Click on the Security Credentials tab.|
Step 4. Navigate to the Access Keys section and choose between making the access key inactive, deleting the key, or rotating the key.Access Keys aws IAM informational Configuration Credential Access Steal Application Access Token 2 EC2 instance data is used to pass start up information into the EC2 instance. This User Data must not contain any sort of credentials. Instead, use an IAM Instance Profile assigned to the instance to grant access to other AWS Services. Auto Scaling group launch configuration User Data with potential credentials exposed Step 1. From the console navigate to the EC2 page.|
Step 2. From the sub-menu, click on ‘Launch Configurations’ under ‘Auto Scaling’.|
Step 3. Select the offending launch configuration.|
Step 4. Scroll down to the ‘Details’ section and click ‘View user data’.|
Step 5. Validate whether or not any credentials are present.|
Step 6. If credentials are present, re-create the launch configuration without exposing any credentials in the user data field.aws Auto Scaling informational Configuration Credential Access Unsecured Credentials: Cloud Instance Metadata API
cs-falcon-cspm-list-service-policy-settings
Returns information about current policy settings.
Base Command
cs-falcon-cspm-list-service-policy-settings
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_id | The policy ID. | Optional |
| cloud_platform | The cloud provider. Possible values are: aws, gcp, azure. Default is aws. | Optional |
| service | Service type to filter by. | Optional |
| limit | The maximum number of entities to list. Default is 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.CSPMPolicySetting.is_remediable | Boolean | Whether the policy setting is remediable or not. |
| CrowdStrike.CSPMPolicySetting.created_at | String | The creation date. |
| CrowdStrike.CSPMPolicySetting.updated_at | String | The update date. |
| CrowdStrike.CSPMPolicySetting.policy_id | Integer | The policy ID. |
| CrowdStrike.CSPMPolicySetting.name | String | The policy setting name. |
| CrowdStrike.CSPMPolicySetting.policy_type | String | The policy type. |
| CrowdStrike.CSPMPolicySetting.cloud_service_subtype | String | The cloud service subtype. |
| CrowdStrike.CSPMPolicySetting.cloud_service | String | The cloud service. |
| CrowdStrike.CSPMPolicySetting.cloud_service_friendly | String | The cloud friendly service. |
| CrowdStrike.CSPMPolicySetting.cloud_asset_type | String | The cloud asset type. |
| CrowdStrike.CSPMPolicySetting.cloud_asset_type_id | Integer | The cloud asset type ID. |
| CrowdStrike.CSPMPolicySetting.cloud_provider | String | The cloud provider. |
| CrowdStrike.CSPMPolicySetting.default_severity | String | The default severity. |
| CrowdStrike.CSPMPolicySetting.policy_timestamp | Date | The policy timestamp. |
| CrowdStrike.CSPMPolicySetting.policy_settings | Array | An array that holds policy settings. |
| CrowdStrike.CSPMPolicySetting.policy_settings.account_id | String | The account ID correlated to the policy. |
| CrowdStrike.CSPMPolicySetting.policy_settings.regions | Array | The regions in which the policy is configured. |
| CrowdStrike.CSPMPolicySetting.policy_settings.severity | String | The severity of the policy. |
| CrowdStrike.CSPMPolicySetting.policy_settings.enabled | Boolean | Whether the policy settings are enabled or not. |
| CrowdStrike.CSPMPolicySetting.policy_settings.tag_excluded | Boolean | Whether the tag is excluded or not. |
| CrowdStrike.CSPMPolicySetting.cis_benchmark | Array | An array of CIS benchmark details. |
| CrowdStrike.CSPMPolicySetting.cis_benchmark.id | Integer | The CIS benchmark ID. |
| CrowdStrike.CSPMPolicySetting.cis_benchmark.benchmark_short | String | The CIS benchmark shortname. |
| CrowdStrike.CSPMPolicySetting.cis_benchmark.recommendation_number | String | The CIS benchmark recommendation number. |
| CrowdStrike.CSPMPolicySetting.pci_benchmark | Array | An array of PCI benchmark details. |
| CrowdStrike.CSPMPolicySetting.pci_benchmark.id | Integer | The PCI benchmark ID. |
| CrowdStrike.CSPMPolicySetting.pci_benchmark.benchmark_short | String | The PCI benchmark shortname. |
| CrowdStrike.CSPMPolicySetting.pci_benchmark.recommendation_number | String | The PCI benchmark recommendation number. |
| CrowdStrike.CSPMPolicySetting.nist_benchmark | Array | An array of NIST benchmark details. |
| CrowdStrike.CSPMPolicySetting.nist_benchmark.id | Integer | The NIST benchmark ID. |
| CrowdStrike.CSPMPolicySetting.nist_benchmark.benchmark_short | String | The NIST benchmark shortname. |
| CrowdStrike.CSPMPolicySetting.nist_benchmark.recommendation_number | String | The NIST benchmark recommendation number. |
| CrowdStrike.CSPMPolicySetting.attack_types | Array | The attack types. |
Command Example
!cs-falcon-cspm-list-service-policy-settings limit=2
Context Example
{
"CrowdStrike": {
"CSPMPolicySetting": [
{
"cis_benchmark": [
{
"benchmark_short": "CIS Controls v8",
"id": 722,
"recommendation_number": "3.11"
}
],
"cloud_asset_type": "filesystem",
"cloud_asset_type_id": 107,
"cloud_provider": "aws",
"cloud_service": "efs",
"cloud_service_friendly": "EFS",
"cloud_service_subtype": "N/A",
"created_at": "2022-08-02T22:17:56.53081Z",
"default_severity": "informational",
"fql_policy": "aws_encrypted:['true']+aws_kms_key_id:['']",
"is_remediable": false,
"name": "EFS File System is encrypted without CMK",
"nist_benchmark": [
{
"benchmark_short": "NIST 800-53 REV 5",
"id": 932,
"recommendation_number": "SC-8(1)"
},
{
"benchmark_short": "NIST 800-53 REV 5",
"id": 989,
"recommendation_number": "SC-28(1)"
}
],
"pci_benchmark": [
{
"benchmark_short": "PCI DSS v3.2.1",
"id": 41,
"recommendation_number": "3.4"
}
],
"policy_id": 1,
"policy_settings": [
{
"account_id": "537409938058",
"enabled": true,
"regions": [
"af-south-1",
"ap-east-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3"
],
"severity": "informational",
"tag_excluded": false
}
],
"policy_timestamp": "0001-01-01T00:00:00Z",
"policy_type": "Configuration",
"updated_at": "2023-07-19T17:31:45.372476Z"
},
{
"cis_benchmark": [
{
"benchmark_short": "CIS 1.4.0 AWS Foundations",
"id": 143,
"recommendation_number": "4.13"
}
],
"cloud_asset_type": "awsaccount",
"cloud_asset_type_id": 116,
"cloud_provider": "aws",
"cloud_service": "awsaccount",
"cloud_service_friendly": "CloudWatch",
"cloud_service_subtype": "Route Table",
"created_at": "2023-01-04T19:57:23.897865Z",
"default_severity": "informational",
"is_remediable": false,
"iso_benchmark": [
{
"benchmark_short": "ISO",
"id": 25,
"recommendation_number": "5.25"
}
],
"name": "CloudWatch log metric filter and alarm missing for changes to route tables",
"nist_benchmark": [
{
"benchmark_short": "NIST 800-53 REV 5",
"id": 184,
"recommendation_number": "AU-6(1)"
},
{
"benchmark_short": "NIST 800-53 REV 5",
"id": 183,
"recommendation_number": "AU-6"
}
],
"pci_benchmark": [
{
"benchmark_short": "PCI DSS v4.0",
"id": 428,
"recommendation_number": "10.4.1"
}
],
"policy_id": 2,
"policy_settings": [
{
"account_id": "537409938058",
"enabled": true,
"regions": [
"af-south-1",
"ap-east-1"
],
"severity": "informational",
"tag_excluded": false
}
],
"policy_timestamp": "0001-01-01T00:00:00Z",
"policy_type": "Configuration",
"soc2_benchmark": [
{
"benchmark_short": "TSC 2017 rev 2020",
"id": 27,
"recommendation_number": "CC7.3"
}
],
"updated_at": "2023-09-18T16:11:58.369644Z"
}
]
}
}
Human Readable Output
CSPM Policy Settings
Policy Id Is Remediable Remediation Summary Name Policy Type Cloud Service Subtype Cloud Service Default Severity 1 false EFS File System is encrypted without CMK Configuration N/A efs informational 2 false CloudWatch log metric filter and alarm missing for changes to route tables Configuration Route Table awsaccount informational
cs-falcon-cspm-update-policy_settings
Updates a policy setting. Can be used to override policy severity or to disable a policy entirely.
Base Command
cs-falcon-cspm-update-policy_settings
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_id | Policy ID to be updated. | Required |
| account_id | Cloud account ID to impact. | Optional |
| enabled | Flag indicating if this policy is enabled. Possible values are: false, true. Default is true. | Optional |
| regions | A comma-separated list of regions where this policy is enforced. | Optional |
| severity | Policy severity value. Possible values are: critical, high, medium, informational. | Optional |
| tag_excluded | Tag exclusion flag. Possible values are: false, true. | Optional |
Context Output
There is no context output for this command.
Command Example
!cs-falcon-cspm-update-policy_settings policy_id=1 enabled=true regions="eu-central-1,eu-central-2" severity=high tag_excluded=false
Human Readable Output
Policy 1 was updated successfully
cs-falcon-resolve-identity-detection
Perform actions on identity detection alerts.
Base Command
cs-falcon-resolve-identity-detection
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of IDs of the alerts to update. | Required |
| assign_to_name | Assign the specified detections to a user based on their username. | Optional |
| assign_to_user_id | Assign the specified detections to a user based on their user ID (Email). | Optional |
| assign_to_uuid | Assign the specified detections to a user based on their UUID. | Optional |
| append_comment | Appends a new comment to any existing comments for the specified detections. | Optional |
| add_tag | Add a tag to the specified detections. | Optional |
| remove_tag | Remove a tag from the specified detections. | Optional |
| update_status | Update the status of the alert to the specified value. Possible values are: new, in_progress, closed, reopened. | Optional |
| unassign | Whether to unassign any assigned users to the specified detections. Possible values are: false, true. | Optional |
| show_in_ui | If true, displays the detection in the UI. Possible values are: false, true. | Optional |
Context Output
There is no context output for this command.
cs-falcon-resolve-mobile-detection
Perform actions on mobile detection alerts.
Base Command
cs-falcon-resolve-mobile-detection
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of IDs of the alerts to update. | Required |
| assign_to_name | Assign the specified detections to a user based on their username. | Optional |
| assign_to_user_id | Assign the specified detections to a user based on their user ID (Email). | Optional |
| assign_to_uuid | Assign the specified detections to a user based on their UUID. | Optional |
| append_comment | Appends a new comment to any existing comments for the specified detections. | Optional |
| add_tag | Add a tag to the specified detections. | Optional |
| remove_tag | Remove a tag from the specified detections. | Optional |
| update_status | Update the status of the alert to the specified value. Possible values are: new, in_progress, closed, reopened. | Optional |
| unassign | Whether to unassign any assigned users to the specified detections. Possible values are: false, true. | Optional |
| show_in_ui | If true, displays the detection in the UI. Possible values are: false, true. | Optional |
Context Output
There is no context output for this command.
cs-falcon-list-users
List users.
Base Command
cs-falcon-list-users
Input
| Argument Name | Description | Required |
|---|---|---|
| id | A comma-separated list of IDs (UUIDs) of specific users to list. | Optional |
| filter | The filter expression that should be used to limit the results. FQL syntax. Available values: assigned_cids, cid, first_name, last_name, name, uid. Example: “first_name:’John’”. | Optional |
| offset | The integer offset to start retrieving records from. | Optional |
| limit | The maximum number of records to return. Default is 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Users.uuid | String | The user’s UUID. |
| CrowdStrike.Users.cid | String | The customer ID. |
| CrowdStrike.Users.uid | String | The user’s ID. |
| CrowdStrike.Users.first_name | String | The user’s first name. |
| CrowdStrike.Users.last_name | String | The user’s last name. |
| CrowdStrike.Users.last_login_at | String | The timestamp of the user’s last login. |
| CrowdStrike.Users.created_at | String | The timestamp of the user’s creation. |
cs-falcon-get-ioarules
Get IOA Rules.
Base Command
cs-falcon-get-ioarules
Input
| Argument Name | Description | Required |
|---|---|---|
| rule_ids | A comma-separated list of rule IDs to get IOA rules for. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.IOARules.instance_id | String | The IOA rule’s instance ID. |
| CrowdStrike.IOARules.customer_id | String | The customer ID. |
| CrowdStrike.IOARules.action_label | String | The IOA rule’s action label. |
| CrowdStrike.IOARules.comment | String | The IOA rule’s comment. |
| CrowdStrike.IOARules.committed_on | String | The timestamp of the IOA rule’s commitment. |
| CrowdStrike.IOARules.created_by | String | The IOA rule’s creator. |
| CrowdStrike.IOARules.created_on | String | The timestamp of the IOA rule’s creation. |
| CrowdStrike.IOARules.deleted | Boolean | Whether the IOA rule is in a deleted status. |
| CrowdStrike.IOARules.description | String | The IOA rule’s description. |
| CrowdStrike.IOARules.disposition_id | String | The disposition ID used by the IOA rule. |
| CrowdStrike.IOARules.enabled | Boolean | Whether the IOA rule is enabled. |
| CrowdStrike.IOARules.field_values | String | The IOA rule’s field values. |
| CrowdStrike.IOARules.instance_version | String | The IOA rule’s instance version. |
| CrowdStrike.IOARules.magic_cookie | String | The IOA rule’s magic cookie. |
| CrowdStrike.IOARules.modified_by | String | The last user who modified the IOA rule. |
| CrowdStrike.IOARules.modified_on | String | The timestamp of the IOA rule’s last modification. |
| CrowdStrike.IOARules.name | String | The IOA rule name. |
| CrowdStrike.IOARules.pattern_id | String | The IOA rule’s pattern ID. |
| CrowdStrike.IOARules.pattern_severity | String | The IOA rule’s pattern severity. |
| CrowdStrike.IOARules.rulegroup_id | String | The IOA rule’s rule group ID. |
| CrowdStrike.IOARules.ruletype_id | String | The IOA rule’s rule type ID. |
| CrowdStrike.IOARules.ruletype_name | String | The IOA rule’s rule type name. |
| CrowdStrike.IOARules.version_ids | String | The IOA rule’s version ID. |
Using Spotlight APIs
Spotlight identifies and gives info about specific vulnerabilities on your hosts using the Falcon sensor.
Required API client scope
To access the Spotlight API, your API client must be assigned the spotlight-vulnerabilities:read scope.
Validating API data
The Falcon sensor continuously monitors hosts for any changes and reports them as they occur.
Depending on the timing of requests, Spotlight APIs can return values that are different from those shown by the Falcon console or an external source.
There are other factors that can cause differences between API responses and other data sources.
API query syntax
If an API query doesn’t exactly match the query used on the Spotlight Vulnerabilities page, the values might differ.
Expired vulnerabilities in Spotlight APIs
If a host is deleted or inactive for 45 days, the status of vulnerabilities on that host changes to expired. Expired vulnerabilities are removed from Spotlight after 3 days.
Expired vulnerabilities are only visible in API responses and are not included in reports or the Falcon console.
An external data source might not use the same data retention policy, which can lead to discrepancies with Spotlight APIs. For more info, see Data retention in Spotlight [https://falcon.crowdstrike.com/login/?next=%2Fdocumentation%2F43%2Ffalcon-spotlight-overview#data-retention-in-spotlight].
The following commands uses the Spotlight API
cs-falcon-spotlight-search-vulnerability
Retrieve vulnerability details according to the selected filter. Each request requires at least one filter parameter. Supported with the CrowdStrike Spotlight license.
Base Command
cs-falcon-spotlight-search-vulnerability
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Limit the vulnerabilities returned to specific properties. Each value must be enclosed in single quotes and placed immediately after the colon with no space. For example, ‘filter=status:’open’+cve.id:[‘CVE-2013-3900’,’CVE-2021-1675’]’. | Optional |
| aid | A comma-separated list of unique agent identifiers (AIDs) of a sensor. | Optional |
| cve_id | A comma-separated list of unique identifiers for a vulnerability as cataloged in the National Vulnerability Database (NVD). This filter supports multiple values and negation. | Optional |
| cve_severity | A comma-separated list of severities of the CVE. The possible values are: CRITICAL, HIGH, MEDIUM, LOW, UNKNOWN, or NONE. | Optional |
| tags | A comma-separated list of names of a tag assigned to a host. Retrieve tags from Host Tags APIs. | Optional |
| status | Status of a vulnerability. This filter supports multiple values and negation. The possible values are: open, closed, reopen, expired. | Optional |
| platform_name | Operating system platform. This filter supports negation. The possible values are: Windows, Mac, Linux. | Optional |
| host_group | A comma-separated list of unique system-assigned IDs of a host group. Retrieve the host group ID from Host Group APIs. | Optional |
| host_type | A comma-separated list of types of hosts a sensor is running on. | Optional |
| last_seen_within | Filter for vulnerabilities based on the number of days since a host last connected to CrowdStrike Falcon. Enter a numeric value from 3 to 45 to indicate the number of days to look back. For example, last_seen_within:10. | Optional |
| is_suppressed | Indicates if the vulnerability is suppressed by a suppression rule. Possible values are: true, false. | Optional |
| display_remediation_info | Display remediation information type of data to be returned for each vulnerability entity. Possible values are: True, False. Default is True. | Optional |
| display_evaluation_logic_info | Whether to return logic information type of data for each vulnerability entity. Possible values are: True, False. Default is True. | Optional |
| display_host_info | Whether to return host information type of data for each vulnerability entity. Possible values are: True, False. Default is False. | Optional |
| limit | The maximum number of items to return (1-2500). Use next_token to retrieve additional pages. Default is 50. |
Optional |
| next_token | Pagination cursor from a previous run’s CrowdStrike.VulnerabilityNextToken output. Provide this value to fetch the next page of vulnerabilities. Expires in 120 seconds. |
Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Vulnerability.id | String | Unique system-assigned ID of the vulnerability. |
| CrowdStrike.Vulnerability.cid | String | Unique system-generated customer identifier (CID) of the account. |
| CrowdStrike.Vulnerability.aid | String | Unique agent identifier (AID) of the sensor where the vulnerability was found. |
| CrowdStrike.Vulnerability.created_timestamp | Date | UTC date and time of when the vulnerability was created in Spotlight. |
| CrowdStrike.Vulnerability.updated_timestamp | Date | UTC date and time of the last update made on the vulnerability. |
| CrowdStrike.Vulnerability.status | String | Vulnerability’s current status. Possible values are: open, closed, reopen, or expired. |
| CrowdStrike.Vulnerability.apps.product_name_version | String | Name and version of the product associated with the vulnerability. |
| CrowdStrike.Vulnerability.apps.sub_status | String | Status of each product associated with the vulnerability. Possible values are: open, closed, or reopen. |
| CrowdStrike.Vulnerability.apps.remediation.ids | String | Remediation ID of each product associated with the vulnerability. |
| CrowdStrike.Vulnerability.host_info.hostname | String | Name of the machine. |
| CrowdStrike.Vulnerability.host_info.instance_id | String | Cloud instance ID of the host. |
| CrowdStrike.Vulnerability.host_info.service_provider_account_id | String | Cloud service provider account ID for the host. |
| CrowdStrike.Vulnerability.host_info.service_provider | String | Cloud service provider for the host. |
| CrowdStrike.Vulnerability.host_info.os_build | String | Operating system build. |
| CrowdStrike.Vulnerability.host_info.product_type_desc | String | Type of host a sensor is running on. |
| CrowdStrike.Vulnerability.host_info.local_ip | String | Device’s local IP address. |
| CrowdStrike.Vulnerability.host_info.machine_domain | String | Active directory domain name. |
| CrowdStrike.Vulnerability.host_info.os_version | String | Operating system version. |
| CrowdStrike.Vulnerability.host_info.ou | String | Active directory organizational unit name. |
| CrowdStrike.Vulnerability.host_info.site_name | String | Active directory site name. |
| CrowdStrike.Vulnerability.host_info.system_manufacturer | String | Name of the system manufacturer. |
| CrowdStrike.Vulnerability.host_info.groups.id | String | Array of host group IDs that the host is assigned to. |
| CrowdStrike.Vulnerability.host_info.groups.name | String | Array of host group names that the host is assigned to. |
| CrowdStrike.Vulnerability.host_info.tags | String | Name of a tag assigned to a host. |
| CrowdStrike.Vulnerability.host_info.platform | String | Operating system platform. This filter supports negation. |
| CrowdStrike.Vulnerability.remediation.entities.id | String | Unique ID of the remediation. |
| CrowdStrike.Vulnerability.remediation.entities.reference | String | Relevant reference for the remediation that can be used to get additional details for the remediation. |
| CrowdStrike.Vulnerability.remediation.entities.title | String | Short description of the remediation. |
| CrowdStrike.Vulnerability.remediation.entities.action | String | Expanded description of the remediation. |
| CrowdStrike.Vulnerability.remediation.entities.link | String | Link to the remediation page for the vendor. In certain cases, this field is null. |
| CrowdStrike.Vulnerability.cve.id | String | Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). |
| CrowdStrike.Vulnerability.cve.base_score | Number | Base score of the CVE (float value between 1 and 10). |
| CrowdStrike.Vulnerability.cve.severity | String | CVSS severity rating of the vulnerability. |
| CrowdStrike.Vulnerability.cve.exploit_status | Number | Numeric value of the most severe known exploit. |
| CrowdStrike.Vulnerability.cve.exprt_rating | String | ExPRT rating assigned by CrowdStrike’s predictive AI rating system. |
| CrowdStrike.Vulnerability.cve.description | String | Brief description of the CVE. |
| CrowdStrike.Vulnerability.cve.published_date | Date | UTC timestamp with the date and time of when the vendor published the CVE. |
| CrowdStrike.Vulnerability.cve.vendor_advisory | String | Link to the vendor page where the CVE was disclosed. |
| CrowdStrike.Vulnerability.cve.exploitability_score | Number | Exploitability score of the CVE (float values from 1-4). |
| CrowdStrike.Vulnerability.cve.impact_score | Number | Impact score of the CVE (float values from 1-6). |
| CrowdStrike.Vulnerability.cve.vector | String | Textual representation of the metric values used to score the vulnerability. |
| CrowdStrike.Vulnerability.cve.remediation_level | String | CVSS remediation level of the vulnerability (U = Unavailable, or O = Official fix). |
| CrowdStrike.Vulnerability.cve.cisa_info.is_cisa_kev | Boolean | Whether to filter for vulnerabilities that are in the CISA Known Exploited Vulnerabilities (KEV) catalog. |
| CrowdStrike.Vulnerability.cve.cisa_info.due_date | Date | Date before which CISA mandates subject organizations to patch the vulnerability. |
| CrowdStrike.Vulnerability.cve.spotlight_published_date | Date | UTC timestamp with the date and time Spotlight enabled coverage for the vulnerability. |
| CrowdStrike.Vulnerability.cve.actors | String | Adversaries associated with the vulnerability. |
| CrowdStrike.Vulnerability.cve.name | String | The vulnerability name. |
| CrowdStrike.VulnerabilityNextToken | String | Pagination cursor returned by CrowdStrike when more results are available. Pass this value back as the `next_token` argument on the next invocation. Absent when no more pages exist. Expires in 120 seconds. |
Command Example
cs-falcon-spotlight-search-vulnerability filter=status:['open','closed'] cve_id=CVE-2021-2222 cve_severity='LOW,HIGH' display_host_info=false display_evaluation_logic_info=false display_remediation_info=false limit=1
Context Example
{
"resources": [
{
"id": "id_num",
"cid": "cid_num",
"aid": "aid_num",
"created_timestamp": "2021-07-13T01:12:57Z",
"updated_timestamp": "2022-10-27T18:32:21Z",
"status": "open",
"apps": [
{
"product_name_version": "product",
"sub_status": "open",
"remediation": {
"ids": [
"1234"
]
},
"evaluation_logic": {
"id": "1234"
}
}
],
"suppression_info": {
"is_suppressed": false
},
"cve": {
"id": "CVE-2021-2222",
"base_score": 5.5,
"severity": "MEDIUM",
"exploit_status": 0,
"exprt_rating": "LOW",
"remediation_level": "O",
"cisa_info": {
"is_cisa_kev": false
},
"spotlight_published_date": "2021-05-10T17:08:00Z",
"description": "description\n",
"published_date": "2021-02-25T23:15:00Z",
"vendor_advisory": [
"web address"
],
"exploitability_score": 1.8,
"impact_score": 3.6,
"vector": "vendor"
}
}
],
"VulnerabilityNextToken": "next_token"
}
Human Readable Output
| CVE ID | CVE Severity | CVE Base Score | CVE Published Date | CVE Impact Score | CVE Exploitability Score | CVE Vector |
|---|---|---|---|---|---|---|
| CVE-2021-2222 | LOW | 5.5 | 2021-05-10T17:08:00Z | 3.6 | 0 | vendor |
cs-falcon-spotlight-list-host-by-vulnerability
Retrieve vulnerability details for a specific ID and host. Supported with the CrowdStrike Spotlight license.
Base Command
cs-falcon-spotlight-list-host-by-vulnerability
Input
| Argument Name | Description | Required |
|---|---|---|
| limit | Maximum number of items to return (1-5000). Default is 50. | Optional |
| cve_ids | Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). This filter supports multiple values and negation. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.VulnerabilityHost.id | String | Unique system-assigned ID of the vulnerability. |
| CrowdStrike.VulnerabilityHost.cid | String | Unique system-generated customer identifier (CID) of the account. |
| CrowdStrike.VulnerabilityHost.aid | String | Unique agent identifier (AID) of the sensor where the vulnerability was found. |
| CrowdStrike.VulnerabilityHost.created_timestamp | Date | UTC date and time of when the vulnerability was created in Spotlight. |
| CrowdStrike.VulnerabilityHost.updated_timestamp | Date | UTC date and time of the last update made on the vulnerability. |
| CrowdStrike.VulnerabilityHost.status | String | Vulnerability’s current status. Possible values are: open, closed, reopen, or expired. |
| CrowdStrike.VulnerabilityHost.apps.product_name_version | String | Name and version of the product associated with the vulnerability. |
| CrowdStrike.VulnerabilityHost.apps.sub_status | String | Status of each product associated with the vulnerability. Possible values are: open, closed, or reopen. |
| CrowdStrike.VulnerabilityHost.apps.remediation.ids | String | Remediation ID of each product associated with the vulnerability. |
| CrowdStrike.VulnerabilityHost.apps.evaluation_logic.id | String | Unique system-assigned ID of the vulnerability evaluation logic. |
| CrowdStrike.VulnerabilityHost.suppression_info.is_suppressed | Boolean | Indicates if the vulnerability is suppressed by a suppression rule. |
| CrowdStrike.VulnerabilityHost.host_info.hostname | String | Name of the machine. |
| CrowdStrike.VulnerabilityHost.host_info.local_ip | String | Device’s local IP address. |
| CrowdStrike.VulnerabilityHost.host_info.machine_domain | String | Active directory domain name. |
| CrowdStrike.VulnerabilityHost.host_info.os_version | String | Operating system version. |
| CrowdStrike.VulnerabilityHost.host_info.ou | String | Active directory organizational unit name. |
| CrowdStrike.VulnerabilityHost.host_info.site_name | String | Active directory site name. |
| CrowdStrike.VulnerabilityHost.host_info.system_manufacturer | String | Name of the system manufacturer. |
| CrowdStrike.VulnerabilityHost.host_info.platform | String | Operating system platform. This filter supports negation. |
| CrowdStrike.VulnerabilityHost.host_info.instance_id | String | Cloud instance ID of the host. |
| CrowdStrike.VulnerabilityHost.host_info.service_provider_account_id | String | Cloud service provider account ID for the host. |
| CrowdStrike.VulnerabilityHost.host_info.service_provider | String | Cloud service provider for the host. |
| CrowdStrike.VulnerabilityHost.host_info.os_build | String | Operating system build. |
| CrowdStrike.VulnerabilityHost.host_info.product_type_desc | String | Type of host a sensor is running on. |
| CrowdStrike.VulnerabilityHost.cve.id | String | Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). |
Command Example
cs-falcon-spotlight-list-host-by-vulnerability cve_ids=CVE-2021-2222
Context Example
{
{
"id": "id",
"cid": "cid",
"aid": "aid",
"created_timestamp": "2021-09-16T15:12:42Z",
"updated_timestamp": "2022-10-19T00:54:43Z",
"status": "open",
"apps": [
{
"product_name_version": "prod",
"sub_status": "open",
"remediation": {
"ids": [
"id"
]
},
"evaluation_logic": {
"id": "id"
}
}
],
"suppression_info": {
"is_suppressed": false
},
"host_info": {
"hostname": "host",
"local_ip": "10.128.0.7",
"machine_domain": "",
"os_version": "version",
"ou": "",
"site_name": "",
"system_manufacturer": "manufactor",
"tags": [],
"platform": "Windows",
"instance_id": "instance id",
"service_provider_account_id": "id",
"service_provider": "id",
"os_build": "os build",
"product_type_desc": "Server"
},
"cve": {
"id": "CVE-20212-2222"
}
}
}
Human Readable Output
| CVE ID | Host Info hostname | Host Info os Version | Host Info Product Type Desc | Host Info Local IP | Host Info ou | Host Info Machine Domain | Host Info Site Name | CVE Exploitability Score | CVE Vector |
|---|---|---|---|---|---|---|---|---|---|
| CVE-20212-2222 | host | 1 | Server | ip | site | 5.5 |
cs-falcon-list-cnapp-alerts
Returns a list of CNAPP alerts. Used for debugging fetch-assets.
Base Command
cs-falcon-list-cnapp-alerts
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | The filter to use for the query. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.CnappAlert.containers_impacted_count | String | The number of containers impacted by the alert. |
| CrowdStrike.CnappAlert.containers_impacted_ids | Array | The list of the ids of containers impacted by the alert. |
| CrowdStrike.CnappAlert.detection_description | String | The description of the alert. |
| CrowdStrike.CnappAlert.detection_event_simple_name | String | The simple name of the alert. |
| CrowdStrike.CnappAlert.detection_name | String | The name of the alert. |
| CrowdStrike.CnappAlert.first_seen_timestamp | String | The first time the alert was seen. |
| CrowdStrike.CnappAlert.last_seen_timestamp | String | The last time the alert was seen. |
| CrowdStrike.CnappAlert.severity | String | The severity of the alert. |
Command Example
cs-falcon-list-cnapp-alerts
Context Example
{
"severity": "Critical",
"first_seen_timestamp": "2025-11-24T11:04:03Z",
"last_seen_timestamp": "2025-11-26T10:18:35Z",
"detection_name": "PotentialKernelTampering",
"detection_event_simple_name": "BPFCommandIssued",
"detection_description": "some decription.",
"containers_impacted_count": "1",
"containers_impacted_ids": ["id1", "id2"],
}
Human Readable Output
| severity | first_seen_timestamp | last_seen_timestamp | detection_name | detection_event_simple_name | detection_description | containers_impacted_count | containers_impacted_ids |
|---|---|---|---|---|---|---|---|
| Critical | 2025-11-24T11:04:03Z | 2025-11-26T10:18:35Z | PotentialKernelTampering | BPFCommandIssued | alert description. | 1 | test |
Troubleshooting
- In the different fetch query configuration parameters such as “Endpoint Detections fetch query” and “Endpoint Incidents fetch query”, to query for multiple values in the same field use the following format:
field:['value1','value2','value3'].- For example, filtering by “severity_name” equal to “Medium”, “High”, or “Critical” can be achieved by specifying
severity_name:['Medium','High','Critical']
- For example, filtering by “severity_name” equal to “Medium”, “High”, or “Critical” can be achieved by specifying
- When encountering the error “400 - Reason: Bad Request: Invalid element in the request”, ensure the integration instance is configured correctly and verify the command arguments.
- For example, the error appears when using the ID of a detection prior to the Raptor release (legacy API) in an integration configured to run with Raptor.
- When experiencing connectivity or authorization errors in Cortex XSOAR 8 or Cortex XSIAM, ensure that the IP addresses associated with the relevant CrowdStrike Falcon region are added to the allow list for the Cortex tenant. For detailed instructions, refer to the Egress section or search for Egress in the product documentation:
- When encountering HTTP 429 errors from CrowdStrike Falcon, install custom engine on the the Cortex tenant and use it in the configuration of the integration instance:
- When encountering missing incidents in Cortex XSOAR, make sure that the ‘Fetch Type’ integration parameter includes the type of the missing incidents.
- Optional types are:
- Endpoint Incident
- Endpoint Detection
- IDP Detection
- Indicator of Misconfiguration
- Indicator of Attack
- Mobile Detection
- On-Demand Scans Detection
- OFP Detection
- Notes:
- Records from the detection endpoint of the CrowdStrike Falcon UI could be of types: “Endpoint Detection” and “OFP Detection”.
- For CNAPP Alerts, you will need one of the following subscriptions:
- Falcon Cloud Security with Containers CNAPP
- Falcon Cloud Security CNAPP
- Falcon Cloud Security with Containers Runtime Protection
- Falcon for Managed Containers Runtime Protection
- Falcon Cloud Security Proactive
- Falcon Cloud Security with Containers
- Falcon for Managed Containers
- Optional types are:
cs-falcon-list-case-summaries
Lists case summaries.
Base Command
cs-falcon-list-case-summaries
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of case IDs. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.Case.id | String | The ID of the case. |
| CrowdStrike.Case.name | String | The name of the case. |
| CrowdStrike.Case.created_timestamp | Date | The date and time the case was created. |
| CrowdStrike.Case.status | String | The status of the case. |
| CrowdStrike.Case.version | String | The version of the case. |
| CrowdStrike.Case.description | String | The description of the case. |
| CrowdStrike.Case.severity | String | The severity of the case. |
| CrowdStrike.Case.assigned_to | String | The name of the user assigned to the case. |
| CrowdStrike.Case.tags | String | The tags of the case. |
cs-falcon-add-case-tag
Adds tags to the specified case.
Base Command
cs-falcon-add-case-tag
Input
| Argument Name | Description | Required |
|---|---|---|
| tags | A comma-separated list of tags. | Required |
| id | The ID of the case the tags will be added to. | Required |
Context Output
There is no context output for this command.
cs-falcon-get-evidence-for-case
Get evidence for a specific case.
Base Command
cs-falcon-get-evidence-for-case
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the case to retrieve evidence for. | Required |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.CaseEvidence.alerts | Array | The alerts associated with the case. |
| CrowdStrike.CaseEvidence.events | Array | The events associated with the case. |
| CrowdStrike.CaseEvidence.leads | Array | The leads associated with the case. |
cs-falcon-resolve-case
Resolves or updates a case.
Base Command
cs-falcon-resolve-case
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the case to resolve. | Required |
| status | The status to set for the case. Possible values are: new, in_progress, closed, reopened. | Optional |
| assigned_to_uuid | A UUID of a user to assign the case to. | Optional |
| description | A new description for the case. | Optional |
| remove_user_assignment | Whether to remove case assignment from the current user. If set to true and assigned_to_uuid is not provided, the case becomes unassigned. If set to false and assigned_to_uuid is provided, the case is reassigned to the specified user UUID. If set to true and assigned_to_uuid is provided, the case is reassigned to the specified user UUID. If this field is omitted and assigned_to_uuid is provided, the case is reassigned to the specified user UUID. Possible values are: true, false. Default is false. |
Optional |
| severity | The new case severity rating (10-100). | Optional |
| template_id | The unique ID of the template to apply to the case. | Optional |
| name | The new name for the case. | Optional |
Context Output
There is no context output for this command.
cs-falcon-delete-case-tag
Deletes a tag from the specified case.
Base Command
cs-falcon-delete-case-tag
Input
| Argument Name | Description | Required |
|---|---|---|
| id | The ID of the case the tags will be deleted from. | Required |
| tag | The tag to delete. | Required |
Context Output
There is no context output for this command.
cs-falcon-search-ngsiem-events
Search NGSIEM historical events. Requires NGSIEM scope with read and write permissions.
Base Command
cs-falcon-search-ngsiem-events
Input
| Argument Name | Description | Required |
|---|---|---|
| repository | The repository to run the query against. . Possible values are: search-all, third-party, falcon_for_it_view, forensics_view, investigate_view. Default is search-all. |
Optional |
| query | The CQL query to use for the search. Note: Double quotes (“) and backslashes () in the queryString must be escaped with a backslash to ensure they are properly interpreted. Example: query=”#event_simpleName = "Event_name"””, For more details see: https://library.humio.com/data-analysis/syntax.html. | Required |
| start | The start of the search window, based on the event timestamp. Note: ‘end’ must be later than ‘start’. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., “1d”, “2h”, “30m”, “1month”), ISO8601 timestamps (e.g., “2026-01-01T00:00:00Z”; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). . |
Optional |
| end | The end of the search window, based on the event timestamp. Note: ‘end’ must be later than ‘start’. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., “1d”, “2h”, “30m”, “1month”), ISO8601 timestamps (e.g., “2026-01-01T00:00:00Z”; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). . |
Optional |
| around_event_id | The ID of the event to search around. Must be provided together with around_timestamp. | Optional |
| around_number_events_before | Number of events to return before the target event. Requires around_event_id and around_timestamp. | Optional |
| around_number_events_after | Number of events to return after the target event. Requires around_event_id and around_timestamp. | Optional |
| around_timestamp | Timestamp for around search. Must be provided together with around_event_id. | Optional |
| ingest_start | The start of the search window, based on the event ingesttimestamp. Note: ‘ingest_end’ must be later than ‘ingest_start’. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., “1d”, “2h”, “30m”, “1month”), ISO8601 timestamps (e.g., “2026-01-01T00:00:00Z”; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). . |
Optional |
| ingest_end | The end of the search window, based on the event ingesttimestamp. Note: ‘ingest_end’ must be later than ‘ingest_start’. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., “1d”, “2h”, “30m”, “1month”), ISO8601 timestamps (e.g., “2026-01-01T00:00:00Z”; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). . |
Optional |
| use_ingest_time | When true, the server uses ingest_start/ingest_end as the query window. when false (or not set), it uses start/end. If both windows are provided, results are constrained by BOTH (AND). Possible values are: true, false. | Optional |
| limit | Maximum number of events to return. Ignored when around_number_events_before or around_number_events_after parameters are specified. Default is 50. | Optional |
| interval_in_seconds | Interval between polling attempts in seconds. To prevent search timeouts, set this value within the 60–90 second range. Default is 60. | Optional |
| timeout_in_seconds | Timeout for polling in seconds. Default is 600. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| CrowdStrike.NGSiemEvent | Array | The list of all events returned from the search. |
| CrowdStrike.NGSiemEvent.id | String | The event ID. |
| CrowdStrike.NGSiemEvent.timestamp | String | Event timestamp. |
Command Example
!cs-falcon-search-ngsiem-events query="#event_simpleName = \"Event_name\"" repository="search-all" start="1d" end="now" limit=2 interval=60 timeout=120
!cs-falcon-search-ngsiem-events query="*" repository="search-all" start="7d" end="now" around_event_id="aaa" around_number_events_before=1 around_number_events_after=1 around_timestamp=1700000000000 interval=60 timeout=120
!cs-falcon-search-ngsiem-events query="id=aaaaa_anchor_event" repository="search-all" ingest_start=1700000000000 ingest_end=1700000002000 use_ingest_time=true limit=2 interval=60 timeout=120
Context Example
{
"CrowdStrike": {
"NGSiemEvent": [
{
"@id": "aaaaa_event_1",
"@timestamp": 1700000000000,
"@ingesttimestamp": "1700000001000",
"id": "aaaaa_event_1",
"event_simpleName": "Event_APIActivityAuditEvent"
},
{
"@id": "aaaaa_event_2",
"@timestamp": 1700000002000,
"@ingesttimestamp": "1700000003000",
"id": "aaaaa_event_2",
"event_simpleName": "Event_APIActivityAuditEvent"
}
]
}
}
Workflow Commands
The following commands are available from the CrowdStrike Falcon integration. Note that for these commands, the required API client scope is: Workflows - Read and Write.
cs-falcon-list-workflow-definitions
Lists workflow definitions from CrowdStrike Falcon.
Base Command
cs-falcon-list-workflow-definitions
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Filters results using a query in Falcon Query Language (FQL). For more information, see the FQL Syntax Documentation: https://www.falconpy.io/Usage/Falcon-Query-Language.html. For a list of available properties, see Workflow execution FQL filters - https://falcon.crowdstrike.com/documentation/page/z028de1a/fusion-workflow-apis#zec519e3. | Optional |
| definition_id | The workflow definition ID to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| activity_id | The activity ID to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| name | The workflow name to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| description | The workflow description to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| offset | The offset to start retrieving records from. Default is 0. | Optional |
| limit | The maximum number of records to return. Max is 500. Default is 50. | Optional |
| sort | A comma-separated list of properties to sort by in the format property.direction (for example name.desc, time.asc, created_at.desc). | Optional |
Context Output
There is no context output for this command.
Command example
!cs-falcon-list-workflow-definitions limit=5
cs-falcon-workflow-execute
Executes an on-demand workflow. Use cs-falcon-list-workflow-definitions to find workflows to run. Note: This command executes on-demand workflows only.
Base Command
cs-falcon-workflow-execute
Input
| Argument Name | Description | Required |
|---|---|---|
| definition_id | A comma-separated list of workflow definition IDs to execute. Either definition_id or name must be provided. | Optional |
| name | The workflow name to execute. Either definition_id or name must be provided. | Optional |
| execution_cid | A comma-separated list of CID(s) to execute the workflow on. | Optional |
| key | The key used for deduplication of workflow executions. If not set, a new UUID is used. | Optional |
| source_event_url | The URL of the source that triggered the workflow execution. | Optional |
| body | The JSON body to pass to the workflow execution. Can be an empty object {}. | Optional |
Context Output
There is no context output for this command.
Command example
!cs-falcon-workflow-execute definition_id="abc123" body="{}"
cs-falcon-list-workflow-executions
Lists workflow executions from CrowdStrike Falcon. Use cs-falcon-workflow-execute to find executions IDs.
Base Command
cs-falcon-list-workflow-executions
Input
| Argument Name | Description | Required |
|---|---|---|
| filter | Filters results using a query in Falcon Query Language (FQL). For more information, see the FQL Syntax Documentation: https://www.falconpy.io/Usage/Falcon-Query-Language.html. For a list of available properties, see Workflow execution FQL filters - https://falcon.crowdstrike.com/documentation/page/z028de1a/fusion-workflow-apis#zec519e3. | Optional |
| definition_id | The workflow definition ID to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| definition_name | The workflow definition name to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| execution_id | The execution ID to filter by. If ‘filter’ is provided, this argument is ignored. | Optional |
| offset | The offset to start retrieving records from. Default is 0. | Optional |
| limit | The maximum number of records to return. Max is 500. Default is 50. | Optional |
| sort | A comma-separated list of properties to sort by in the format property.direction (for example name.desc, time.asc, created_at.desc). | Optional |
Context Output
There is no context output for this command.
Command example
!cs-falcon-list-workflow-executions limit=10
cs-falcon-list-workflow-execution-results
Gets detailed results for specific workflow executions. Use cs-falcon-list-workflow-executions to find execution IDs.
Base Command
cs-falcon-list-workflow-execution-results
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of workflow execution IDs to retrieve results for. | Required |
Context Output
There is no context output for this command.
Command example
!cs-falcon-list-workflow-execution-results ids="exec_id_1,exec_id_2"
cs-falcon-workflow-execution-action
Performs an action (cancel or resume) on one or more workflow executions. Use cs-falcon-list-workflow-execution-results to find execution activity status.
Base Command
cs-falcon-workflow-execution-action
Input
| Argument Name | Description | Required |
|---|---|---|
| ids | A comma-separated list of workflow execution IDs to perform the action on. Get the workflow execution ID using cs-falcon-list-workflow-executions. | Required |
| action_name | The action to perform on the workflow executions. Possible values are: cancel, resume. | Required |
Context Output
There is no context output for this command.
Command example
!cs-falcon-workflow-execution-action ids="exec_id_1" action_name="cancel"
<~PLATFORM>
License Requirements
The following configuration parameters require the Cortex XSIAM license:
- Fetch events
The following configuration parameters require Cortex XSIAM with the Exposure Management add-on:
- Fetch assets and vulnerabilities
The following configuration parameters require one of these licenses: Cortex XSIAM or Agentix:
- Fetch incidents
</~PLATFORM>
Configuration parameters
legacy_version— Use legacy APIurl— Server URL (e.g., https://api.crowdstrike.com) (required)credentials— Client IDclient_id— Client IDsecret— SecretReliability— Source ReliabilityisFetch— Fetch incidentsfetch_incidents_or_detections— Incident Fetch typesincidentType— Incident typefetch_time— First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)incidents_per_fetch— Max incidents per fetchincidentFetchInterval— Incidents Fetch Intervallook_back— Advanced: Time in minutes to look back when fetching incidents and detectionsfetch_query— Endpoint Detections filter queryidp_detections_fetch_query— IDP Detections filter querymobile_detections_fetch_query— Mobile Detections filter queryiom_fetch_query— IOM filter queryioa_fetch_query— IOA filter queryon_demand_fetch_query— Detections from On-Demand Scans filter queryofp_detection_fetch_query— OFP Detections filter querythird_party_detection_fetch_query— Third Party Detection fetch queryngsiem_detection_fetch_query— NGSIEM Detection fetch queryautomated_leads_fetch_query— NGSIEM automated leads fetch queryngsiem_cases_fetch_query— NGSIEM cases fetch queryngsiem_incidents_fetch_query— NGSIEM incidents fetch queryrecon_fetch_query— Recon filter querymirror_direction— Mirroring Directionclose_incident— Close Mirrored XSOAR Incidentclose_in_cs_falcon— Close Mirrored CrowdStrike Falcon Incident or Detectionreopen_statuses— Reopen StatusesisFetchEvents— Fetch eventsfetch_events_or_detections— Event Fetch typeseventFetchInterval— Events Fetch Intervallook_back_xsiam— Advanced: Time in minutes to look back when fetching events and detectionsisFetchAssets— Fetch assets and vulnerabilitiesfetch_assets_type— Fetch Asset typesassetsFetchInterval— Assets Fetch Intervalinsecure— Trust any certificate (not secure)proxy— Use system proxy settings
Commands (98)
-
cs-device-ran-onDeprecatedReturns a list of device IDs an indicator ran on.
-
cs-falcon-add-case-tagAdds tags to the specified case.
-
cs-falcon-add-host-group-membersAdd host group members.
-
cs-falcon-apply-quarantine-file-actionApply action to quarantined files by file IDs or filter.
-
cs-falcon-batch-upload-custom-iocUploads a batch of indicators.
-
cs-falcon-contain-hostContains containment for a specified host. When contained, a host can only communicate with the CrowdStrike cloud and any IPs specified in your containment policy.
-
cs-falcon-create-host-groupCreate a host group.
-
cs-falcon-create-ioa-exclusionCreate an IOA exclusion.
-
cs-falcon-create-ml-exclusionCreate an ML exclusion.
-
cs-falcon-cspm-list-policy-detailsGiven a CSV list of policy IDs, returns detailed policy information.
-
cs-falcon-cspm-list-service-policy-settingsReturns information about current policy settings.
-
cs-falcon-cspm-update-policy_settingsUpdates a policy setting. Can be used to override policy severity or to disable a policy entirely.
-
cs-falcon-delete-case-tagDeletes a tag from the specified case.
-
cs-falcon-delete-custom-iocDeletes a monitored indicator.
-
cs-falcon-delete-fileDeletes a file based on the provided ID or name. Can delete only one file at a time.
-
cs-falcon-delete-host-groupsDeletes the requested host groups.
-
cs-falcon-delete-ioa-exclusionDelete the IOA exclusions by ID.
-
cs-falcon-delete-iocDeprecatedDeprecated. Use the cs-falcon-delete-custom-ioc command instead.
-
cs-falcon-delete-ml-exclusionDelete the ML exclusions by ID.
-
cs-falcon-delete-scriptDeletes a custom-script based on the provided ID. Can delete only one script at a time.
-
cs-falcon-device-count-iocThe number of hosts that observed the provided IOC.
-
cs-falcon-device-ran-onReturns a list of device IDs an indicator ran on.
-
cs-falcon-get-behaviorDeprecatedSearches for and fetches the behavior that matches the query. Deprecated - No replacement available.
-
cs-falcon-get-custom-iocGets the full definition of one or more indicators that you are watching.
-
cs-falcon-get-evidence-for-caseGet evidence for a specific case.
-
cs-falcon-get-extracted-fileGets the RTR extracted file contents for the specified session and SHA256 hash.
-
cs-falcon-get-fileReturns files based on the provided IDs. These files are used for the RTR 'put' command.
-
cs-falcon-get-ioarulesGet IOA Rules.
-
cs-falcon-get-iocDeprecatedDeprecated. Use the cs-falcon-get-custom-ioc command instead.
-
cs-falcon-get-scriptReturns custom scripts based on the provided ID. Used for the RTR 'runscript' command.
-
cs-falcon-lift-host-containmentLifts containment on the host, which returns its network communications to normal. When lift_filesystem_containment_all is set to true, lifts filesystem containment instead.
-
cs-falcon-list-case-summariesLists case summaries.
-
cs-falcon-list-cnapp-alertsReturns a list of CNAPP alerts. Used for debugging fetch-assets.
-
cs-falcon-list-detection-summariesLists detection summaries.
-
cs-falcon-list-filesReturns a list of put-file IDs that are available for the user in the 'put' command. Due to an API limitation, the maximum number of files returned is 100.
-
cs-falcon-list-host-filesGets a list of files for the specified RTR session on a host.
-
cs-falcon-list-host-group-membersGets the list of host group members.
-
cs-falcon-list-host-groupsList the available host groups.
-
cs-falcon-list-identity-entitiesList identity entities.
-
cs-falcon-list-quarantined-fileGet quarantine file metadata by specified IDs or filter.
-
cs-falcon-list-scriptsReturns a list of custom script IDs that are available for the user in the 'runscript' command.
-
cs-falcon-list-usersList users.
-
cs-falcon-list-workflow-definitionsLists workflow definitions from CrowdStrike Falcon.
-
cs-falcon-list-workflow-execution-resultsGets detailed results for specific workflow executions. Use cs-falcon-list-workflow-executions to find execution IDs.
-
cs-falcon-list-workflow-executionsLists workflow executions from CrowdStrike Falcon. Use cs-falcon-workflow-execute to find executions IDs.
-
cs-falcon-ods-create-scanCreate an ODS scan and wait for the results.
-
cs-falcon-ods-create-scheduled-scanCreate an ODS scheduled scan.
-
cs-falcon-ods-delete-scheduled-scanDelete ODS scheduled scans.
-
cs-falcon-ods-query-malicious-filesRetrieve ODS malicious file details.
-
cs-falcon-ods-query-scanRetrieve ODS scan details.
-
cs-falcon-ods-query-scan-hostRetrieve ODS scan host details.
-
cs-falcon-ods-query-scheduled-scanRetrieve ODS scheduled scan details.
-
cs-falcon-process-detailsRetrieves the details of a process, according to the process ID that is running or that previously ran.
-
cs-falcon-processes-ran-onGet processes associated with a given IOC.
-
cs-falcon-refresh-sessionRefresh a session timeout on a single host.
-
cs-falcon-remove-host-group-membersRemove host group members.
-
cs-falcon-resolve-caseResolves or updates a case.
-
cs-falcon-resolve-detectionResolves and updates a detection using the provided arguments. At least one optional argument must be passed, otherwise no change will take place. Note that IDP detections are not supported.
-
cs-falcon-resolve-identity-detectionPerform actions on identity detection alerts.
-
cs-falcon-resolve-mobile-detectionPerform actions on mobile detection alerts.
-
cs-falcon-rtr-kill-processExecute an active responder kill command on a single host.
-
cs-falcon-rtr-list-network-statsExecutes an RTR active-responder netstat command to get a list of network status and protocol statistics across the given host.
-
cs-falcon-rtr-list-processesExecutes an RTR active-responder ps command to get a list of active processes across the given host.
-
cs-falcon-rtr-list-scheduled-tasksExecutes an RTR active-responder netstat command to get a list of scheduled tasks across the given host. This command is valid only for Windows hosts.
-
cs-falcon-rtr-read-registryExecutes an RTR active-responder read registry keys command across the given hosts. This command is valid only for Windows hosts.
-
cs-falcon-rtr-remove-fileBatch executes an RTR active-responder remove file across the hosts mapped to the given batch ID.
-
cs-falcon-rtr-retrieve-fileGets the RTR extracted file contents for the specified file path.
-
cs-falcon-run-commandSends commands to hosts.
-
cs-falcon-run-get-commandBatch executes 'get' command across hosts to retrieve files.
-
cs-falcon-run-scriptRuns a script on the agent host.
-
cs-falcon-search-custom-iocsReturns a list of your uploaded IOCs that match the search criteria.
-
cs-falcon-search-detectionSearch for details of specific detections, either using a filter query, or by providing the IDs of the detections.
-
cs-falcon-search-deviceSearches for a device that matches the query.
-
cs-falcon-search-ioa-exclusionGet a list of IOA exclusions by specifying their IDs or a filter.
-
cs-falcon-search-iocsDeprecatedDeprecated. Use the cs-falcon-search-custom-iocs command instead.
-
cs-falcon-search-ml-exclusionGet a list of ML exclusions by specifying their IDs, value, or a specific filter.
-
cs-falcon-search-ngsiem-eventsSearch NGSIEM historical events. Requires NGSIEM scope with read and write permissions.
-
cs-falcon-spotlight-list-host-by-vulnerabilityRetrieve vulnerability details for a specific ID and host. Supported with the CrowdStrike Spotlight license.
-
cs-falcon-spotlight-search-vulnerabilityRetrieve vulnerability details according to the selected filter. Each request requires at least one filter parameter. Supported with the CrowdStrike Spotlight license.
-
cs-falcon-status-commandGets the status of a command executed on a host.
-
cs-falcon-status-get-commandRetrieves the status of the specified batch 'get' command.
-
cs-falcon-update-custom-iocUpdates an indicator for CrowdStrike to monitor.
-
cs-falcon-update-host-groupUpdates a host group.
-
cs-falcon-update-ioa-exclusionUpdates an IOA exclusion. At least one argument is required in addition to the id argument.
-
cs-falcon-update-iocDeprecatedDeprecated. Use the cs-falcon-update-custom-ioc command instead.
-
cs-falcon-update-ml-exclusionUpdates an ML exclusion. At least one argument is required in addition to the id argument.
-
cs-falcon-upload-custom-iocUploads an indicator for CrowdStrike to monitor.
-
cs-falcon-upload-fileUploads a file to the CrowdStrike cloud. (Can be used for the RTR 'put' command).
-
cs-falcon-upload-iocDeprecatedDeprecated. Use the cs-falcon-upload-custom-ioc command instead.
-
cs-falcon-upload-scriptUploads a script to Falcon CrowdStrike.
-
cs-falcon-workflow-executeExecutes an on-demand workflow. Use cs-falcon-list-workflow-definitions to find workflows to run. Note: This command executes on-demand workflows only.
-
cs-falcon-workflow-execution-actionPerforms an action (cancel or resume) on one or more workflow executions. Use cs-falcon-list-workflow-execution-results to find execution activity status.
-
cveRetrieve vulnerability details according to the selected filter. Each request requires at least one filter parameter. Supported with the CrowdStrike Spotlight license.
-
endpointReturns information about an endpoint. Does not support regex.
-
get-mapping-fieldsReturns the list of fields to map in outgoing mirroring. This command is only used for debugging purposes. Note that this command is supported in Cortex XSOAR only.
-
get-modified-remote-dataGets the list of incidents and detections that were modified since the last update time. This method is used for debugging purposes. The get-modified-remote-data command is used as part of the Mirroring feature that was introduced in Cortex XSOAR version 6.1. Note that this command is supported in Cortex XSOAR only.
-
get-remote-dataGets remote data from a remote incident or detection. This method does not update the current incident or detection, and should be used for debugging purposes only. Note that this command is supported in Cortex XSOAR only.
-
update-remote-systemUpdates the remote incident or detection with local incident or detection changes. This method is only used for debugging purposes and will not update the current incident or detection. Note that this command is supported in Cortex XSOAR only.
category: Endpoint provider: CrowdStrike sectionorder: - Connect - Collect commonfields: id: CrowdstrikeFalcon version: -1 configuration: - defaultvalue: 'false' display: Use legacy API name: legacy_version type: 8 section: Connect advanced: true hidden: true additionalinfo: "Use the legacy version of the API, which refers to versions prior to the 'Next Generation Raptor release.'" - display: Server URL (e.g., https://api.crowdstrike.com) name: url type: 0 section: Connect required: true defaultvalue: https://api.crowdstrike.com - display: Client ID name: credentials type: 9 section: Connect required: false displaypassword: Secret - display: Client ID name: client_id type: 0 hidden: true section: Connect required: false - display: Secret name: secret type: 4 section: Connect required: false hidden: true - display: Source Reliability name: Reliability type: 15 defaultvalue: 'A+ - 3rd party enrichment' section: Collect required: false additionalinfo: Reliability of the source providing the intelligence data. Currently used for “CVE” reputation command. options: - A+ - 3rd party enrichment - A - Completely reliable - B - Usually reliable - C - Fairly reliable - D - Not usually reliable - E - Unreliable - F - Reliability cannot be judged advanced: true - display: Fetch incidents name: isFetch type: 8 section: Collect required: false defaultvalue: 'false' hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: 'Incident Fetch types' defaultvalue: 'Endpoint Detection' name: fetch_incidents_or_detections type: 16 section: Collect required: false additionalinfo: |- Choose what incident types to fetch - You can choose any combination. Note: Records from the detection endpoint of the CrowdStrike Falcon UI could be of types: 'Endpoint Detection' and 'OFP Detection'. options: - IDP Detection - Endpoint Detection - Indicator of Misconfiguration - Indicator of Attack - Mobile Detection - On-Demand Scans Detection - OFP Detection - Third Party Detection - NGSIEM Detection - NGSIEM Automated Lead - NGSIEM Case - NGSIEM Incident (XDR Alert) - Recon notifications hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: Incident type name: incidentType type: 13 section: Connect required: false hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days) name: fetch_time type: 0 defaultvalue: '3 days' section: Collect required: false additionalinfo: Supported in Cortex XSOAR and Cortex Platform. hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: Max incidents per fetch name: incidents_per_fetch type: 0 section: Collect advanced: true required: false defaultvalue: '15' additionalinfo: Supported in Cortex XSOAR and Cortex Platform. Input a value between 1-500. Default is 15. hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: 'Incidents Fetch Interval' defaultvalue: '1' name: incidentFetchInterval additionalinfo: Supported in Cortex XSOAR and Cortex Platform. type: 19 section: Collect advanced: true required: false hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: 'Advanced: Time in minutes to look back when fetching incidents and detections' additionalinfo: Use this parameter to determine the look-back period for searching for incidents that were created before the last run time and did not match the query when they were created. defaultvalue: 2 name: look_back type: 0 section: Collect advanced: true required: false hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: Endpoint Detections filter query name: fetch_query type: 0 section: Collect advanced: true required: false additionalinfo: 'Use the Falcon Query Language to refine the data collected. For more information, refer to the FQL syntax documentation: https://www.falconpy.io/Usage/Falcon-Query-Language.html' - display: IDP Detections filter query name: idp_detections_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: Mobile Detections filter query name: mobile_detections_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: IOM filter query name: iom_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: IOA filter query name: ioa_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: "The Indicator of Attack (IOA) fetch query. This is an FQL filter that is combined with the time-range filter using AND. For example: cloud_provider:'aws'. For more information, see the Falcon Query Language (FQL) documentation at: https://www.falconpy.io/Usage/Falcon-Query-Language.html." hidden: - marketplacev2 supportedModules: - "xsiam" - "agentix" - display: Detections from On-Demand Scans filter query name: on_demand_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: OFP Detections filter query name: ofp_detection_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: Third Party Detection fetch query name: third_party_detection_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: NGSIEM Detection fetch query name: ngsiem_detection_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: NGSIEM automated leads fetch query name: automated_leads_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: NGSIEM cases fetch query name: ngsiem_cases_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: NGSIEM incidents fetch query name: ngsiem_incidents_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: Recon filter query name: recon_fetch_query type: 0 section: Collect required: false advanced: true additionalinfo: 'Use Falcon Query Language (FQL) to filter results. For more information, see the [FQL Syntax Documentation](https://www.falconpy.io/Usage/Falcon-Query-Language.html).' - display: 'Mirroring Direction' name: mirror_direction type: 15 section: Collect required: false additionalinfo: 'Choose the direction to mirror the detection: Incoming (from CrowdStrike Falcon to Cortex XSOAR), Outgoing (from Cortex XSOAR to CrowdStrike Falcon), or Incoming and Outgoing (to/from CrowdStrike Falcon and Cortex XSOAR).' defaultvalue: None options: - None - Incoming - Outgoing - Incoming And Outgoing hidden: - marketplacev2 - platform - display: 'Close Mirrored XSOAR Incident' defaultvalue: 'false' name: close_incident type: 8 section: Collect advanced: true required: false additionalinfo: When selected, closing the CrowdStrike Falcon incident is mirrored in Cortex XSOAR. hidden: - marketplacev2 - platform - display: 'Close Mirrored CrowdStrike Falcon Incident or Detection' defaultvalue: 'false' name: close_in_cs_falcon type: 8 section: Collect advanced: true required: false additionalinfo: When selected, closing the Cortex XSOAR incident is mirrored in CrowdStrike Falcon, according to the types that were chosen to be fetched and mirrored. hidden: - marketplacev2 - platform - display: 'Reopen Statuses' additionalinfo: CrowdStrike Falcon statuses that will reopen an incident in Cortex XSOAR if closed. You can choose any combination. defaultvalue: 'New,In progress,True positive,False positive,Reopened,Ignored' name: reopen_statuses type: 16 section: Collect advanced: true required: false options: - New - In progress - True positive - False positive - Reopened - Ignored hidden: - marketplacev2 - platform - display: Fetch events name: isFetchEvents type: 8 section: Collect required: false defaultvalue: 'false' hidden: - xsoar supportedModules: - "xsiam" - display: 'Event Fetch types' defaultvalue: 'IDP Detection,Endpoint Detection,Mobile Detection,On-Demand Scans Detection,OFP Detection' name: fetch_events_or_detections type: 16 section: Collect required: false additionalinfo: |- Choose what event types to fetch - You can choose any combination. Note: Records from the detection endpoint of the CrowdStrike Falcon UI could be of types: 'Endpoint Detection' and 'OFP Detection'. options: - IDP Detection - Endpoint Detection - Mobile Detection - On-Demand Scans Detection - OFP Detection hidden: - xsoar - xpanse supportedModules: - "xsiam" - "edr" - "cloud" - "cloud_runtime_security" - display: 'Events Fetch Interval' defaultvalue: '1' name: eventFetchInterval type: 19 section: Collect advanced: true required: false hidden: - xsoar - xpanse supportedModules: - "xsiam" - display: 'Advanced: Time in minutes to look back when fetching events and detections' additionalinfo: Use this parameter to determine the look-back period for searching for events that were created before the last run time and did not match the query when they were created. defaultvalue: 2 name: look_back_xsiam type: 0 section: Collect advanced: true required: false hidden: - xsoar - xpanse supportedModules: - "xsiam" - "edr" - "cloud" - "cloud_runtime_security" - display: Fetch assets and vulnerabilities name: isFetchAssets type: 8 section: Collect required: false defaultvalue: 'false' hidden: - xsoar - xpanse supportedModules: - "xsiam" - "exposure_management" - display: 'Fetch Asset types' name: fetch_assets_type defaultvalue: 'Spotlight,CNAPP Alerts' type: 16 section: Collect advanced: false required: false additionalinfo: |- The asset sources to ingest into the Cortex Unified Asset Inventory. options: - Spotlight - CNAPP Alerts hidden: - xsoar supportedModules: - "xsiam" - "exposure_management" - additionalinfo: The fetch interval for assets and vulnerabilities. It is recommended to set it to 1 hour. defaultvalue: 60 display: Assets Fetch Interval name: assetsFetchInterval type: 19 section: Collect advanced: true required: false hidden: - xsoar - xpanse supportedModules: - "xsiam" - "exposure_management" - display: 'Trust any certificate (not secure)' name: insecure type: 8 section: Connect advanced: true required: false - display: 'Use system proxy settings' name: proxy type: 8 section: Connect advanced: true required: false description: The CrowdStrike Falcon OAuth 2 API (formerly the Falcon Firehose API), enables fetching and resolving detections, searching devices, getting behaviors by ID, containing hosts, and lifting host containment. display: CrowdStrike Falcon name: CrowdstrikeFalcon script: commands: - arguments: - name: extended_data predefined: - Yes - No description: Whether or not to get additional data about the device. auto: PREDEFINED - description: The query by which to filter the device. The query format should be `filter_parameter_name:'filter_value'`. name: filter - description: The maximum records to return [1-5000]. name: limit defaultValue: 50 - description: The offset to start retrieving records from. name: offset defaultValue: 0 - description: 'A comma-separated list of device IDs to limit the results.' name: ids - description: The status of the device. name: status auto: PREDEFINED predefined: - 'normal' - containment_pending - contained - lift_containment_pending - description: The hostname of the device. name: hostname - description: The platform name of the device. name: platform_name auto: PREDEFINED predefined: - 'Windows' - Mac - Linux - description: 'The site name of the device.' name: site_name - description: The property to sort by (e.g., status.desc or hostname.asc). name: sort description: Searches for a device that matches the query. name: cs-falcon-search-device outputs: - contextPath: CrowdStrike.Device.ID description: The ID of the device. type: String - contextPath: CrowdStrike.Device.LocalIP description: The local IP address of the device. type: String - contextPath: CrowdStrike.Device.ExternalIP description: The external IP address of the device. type: String - contextPath: CrowdStrike.Device.Hostname description: The hostname of the device. type: String - contextPath: CrowdStrike.Device.OS description: The operating system of the device. type: String - contextPath: CrowdStrike.Device.MacAddress description: The MAC address of the device. type: String - contextPath: CrowdStrike.Device.FirstSeen description: The first time the device was seen. type: String - contextPath: CrowdStrike.Device.LastSeen description: The last time the device was seen. type: String - contextPath: CrowdStrike.Device.PolicyType description: The policy type of the device. type: String - contextPath: CrowdStrike.Device.Status description: The device status. type: String - contextPath: Endpoint.Hostname description: The endpoint hostname. type: String - contextPath: Endpoint.OS description: The endpoint operation system. type: String - contextPath: Endpoint.IPAddress description: The endpoint IP address. type: String - contextPath: Endpoint.ID description: The endpoint ID. type: String - contextPath: Endpoint.Status description: The endpoint status. type: String - contextPath: Endpoint.IsIsolated description: The endpoint isolation status. type: String - contextPath: Endpoint.MACAddress description: The endpoint MAC address. type: String - contextPath: Endpoint.Vendor description: The integration name of the endpoint vendor. type: String - contextPath: Endpoint.OSVersion description: The endpoint operation system version. type: String - arguments: - description: The ID of the behavior. The ID of the behavior can be retrieved by running the cs-falcon-search-detection or cs-falcon-get-detections-for-incident command. name: behavior_id required: true description: Searches for and fetches the behavior that matches the query. Deprecated - No replacement available. name: cs-falcon-get-behavior outputs: - contextPath: CrowdStrike.Behavior.FileName description: The filename of the behavior. type: String - contextPath: CrowdStrike.Behavior.Scenario description: The scenario name of the behavior. type: String - contextPath: CrowdStrike.Behavior.MD5 description: The MD5 hash of the IOC in the behavior. type: String - contextPath: CrowdStrike.Behavior.SHA256 description: The SHA256 hash of the IOC in the behavior. type: String - contextPath: CrowdStrike.Behavior.IOCType description: The type of the indicator of compromise. type: String - contextPath: CrowdStrike.Behavior.IOCValue description: The value of the indicator of compromise. type: String - contextPath: CrowdStrike.Behavior.CommandLine description: The command line executed in the behavior. type: String - contextPath: CrowdStrike.Behavior.UserName description: The username related to the behavior. type: String - contextPath: CrowdStrike.Behavior.SensorID description: The sensor ID related to the behavior. type: String - contextPath: CrowdStrike.Behavior.ParentProcessID description: The ID of the parent process. type: String - contextPath: CrowdStrike.Behavior.ProcessID description: The process ID of the behavior. type: String - contextPath: CrowdStrike.Behavior.ID description: The ID of the behavior. type: String deprecated: true - arguments: - description: A comma-separated list of IDs of the detections to search. If provided, will override other arguments. isArray: true name: ids - description: |- Filter detections using a query in Falcon Query Language (FQL). For example, filter="device.hostname:'CS-SE-TG-W7-01'" For a full list of valid filter options, see: https://falcon.crowdstrike.com/support/documentation/2/query-api-reference#detectionsearch name: filter defaultValue: "product:'epp'+type:'ldt'" - auto: PREDEFINED description: Whether to get additional data such as device and behaviors processed. name: extended_data predefined: - Yes - No description: Search for details of specific detections, either using a filter query, or by providing the IDs of the detections. name: cs-falcon-search-detection outputs: - contextPath: CrowdStrike.Detection.Behavior.FileName description: The filename of the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.Scenario description: The scenario name of the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.MD5 description: The MD5 hash of the IOC of the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.SHA256 description: The SHA256 hash of the IOC of the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.IOCType description: The type of the IOC. type: String - contextPath: CrowdStrike.Detection.Behavior.IOCValue description: The value of the IOC. type: String - contextPath: CrowdStrike.Detection.Behavior.CommandLine description: The command line executed in the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.UserName description: The username related to the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.SensorID description: The sensor ID related to the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.ParentProcessID description: The ID of the parent process. type: String - contextPath: CrowdStrike.Detection.Behavior.ProcessID description: The process ID of the behavior. type: String - contextPath: CrowdStrike.Detection.Behavior.ID description: The ID of the behavior. type: String - contextPath: CrowdStrike.Detection.System description: The system name of the detection. type: String - contextPath: CrowdStrike.Detection.CustomerID description: The ID of the customer (CID). type: String - contextPath: CrowdStrike.Detection.MachineDomain description: The name of the domain of the detection machine. type: String - contextPath: CrowdStrike.Detection.ID description: The detection ID. type: String - contextPath: CrowdStrike.Detection.ProcessStartTime description: The start time of the process that generated the detection. type: Date - arguments: - description: A comma-separated list of one or more IDs to resolve. name: ids required: true - auto: PREDEFINED description: "The status to transition a detection to." name: status predefined: - new - in_progress - closed - reopened - description: 'A user ID, for example: 1234567855512345678. username and assigned_to_uuid are mutually exclusive.' name: assigned_to_uuid - description: Optional comment to add to the detection. Comments are displayed with the detection in CrowdStrike Falcon and provide context or notes for other Falcon users. name: comment - auto: PREDEFINED description: If true, displays the detection in the UI. name: show_in_ui predefined: - 'true' - 'false' - description: Username to assign the detections to. (This is usually the user's email address, but may vary based on your configuration). username and assigned_to_uuid are mutually exclusive. name: username - description: The tag to add to the detection, supported only for API V3. name: tag description: Resolves and updates a detection using the provided arguments. At least one optional argument must be passed, otherwise no change will take place. Note that IDP detections are not supported. name: cs-falcon-resolve-detection - arguments: - description: A comma-separated list of host agent IDs (AID) of the host to contain. Get an agent ID from a detection. isArray: true name: ids required: true description: Contains containment for a specified host. When contained, a host can only communicate with the CrowdStrike cloud and any IPs specified in your containment policy. name: cs-falcon-contain-host compliantpolicies: - EndPoint Isolation - arguments: - description: A comma-separated list of host agent IDs (AIDs) of the hosts to contain. Get an agent ID from a detection. isArray: true name: ids required: true - auto: PREDEFINED defaultValue: 'false' description: Whether to lift filesystem containment instead of network containment. When set to true, uses the lift_filesystem_containment_all action to remove filesystem containment from the specified hosts. name: lift_filesystem_containment_all predefined: - 'true' - 'false' description: Lifts containment on the host, which returns its network communications to normal. When lift_filesystem_containment_all is set to true, lifts filesystem containment instead. name: cs-falcon-lift-host-containment compliantpolicies: - EndPoint Isolation - arguments: - description: Any commands run against an offline-queued session will be queued up and executed when the host comes online. name: queue_offline defaultValue: false - description: A comma-separated list of host agent IDs to run commands for. The list of host agent IDs can be retrieved by running the 'cs-falcon-search-device' command. name: host_ids required: true - description: The type of command to run. name: command_type required: true - description: The full command to run. name: full_command required: true - auto: PREDEFINED defaultValue: read description: 'The scope to run the command for. (NOTE: In order to run the CrowdStrike RTR `put` command, it is necessary to pass `scope=admin`).' name: scope predefined: - read - write - admin - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. defaultValue: "180" type: unknown - auto: PREDEFINED defaultValue: batch description: The target to run the command for. name: target predefined: - batch - single - description: A batch ID to execute the command on. name: batch_id description: Sends commands to hosts. name: cs-falcon-run-command outputs: - contextPath: CrowdStrike.Command.HostID description: The ID of the host the command was running for. type: String - contextPath: CrowdStrike.Command.SessionID description: The session ID of the host. type: string - contextPath: CrowdStrike.Command.Stdout description: The standard output of the command. type: String - contextPath: CrowdStrike.Command.Stderr description: The standard error of the command. type: String - contextPath: CrowdStrike.Command.BaseCommand description: The base command. type: String - contextPath: CrowdStrike.Command.FullCommand description: The full command. type: String - contextPath: CrowdStrike.Command.TaskID description: (For single host) The ID of the command request which has been accepted. type: string - contextPath: CrowdStrike.Command.Complete description: (For single host) True if the command completed. type: boolean - contextPath: CrowdStrike.Command.NextSequenceID description: (For single host) The next sequence ID. type: number - contextPath: CrowdStrike.Command.BatchID description: The Batch ID that the command was executed on. type: String - arguments: - description: The script name to upload. name: name required: true - auto: PREDEFINED defaultValue: private description: 'The permission type for the custom script. Possible values are: "private", which is used only by the user who uploaded it, "group", which is used by all RTR Admins, and "public", which is used by all active-responders and RTR admins.' name: permission_type predefined: - private - group - public - description: The content of the PowerShell script. name: content required: true description: Uploads a script to Falcon CrowdStrike. name: cs-falcon-upload-script - arguments: - description: The file entry ID to upload. name: entry_id required: true description: Uploads a file to the CrowdStrike cloud. (Can be used for the RTR 'put' command). name: cs-falcon-upload-file - arguments: - description: The ID of the file to delete. Either this argument or file_name is required. When both are specified, file_id takes precedence. name: file_id - description: The name of the file to delete. Either this argument or file_id is required. When both are specified, file_id takes precedence. name: file_name description: Deletes a file based on the provided ID or name. Can delete only one file at a time. name: cs-falcon-delete-file - arguments: - description: A comma-separated list of file IDs to get. The list of file IDs can be retrieved by running the 'cs-falcon-list-files' command. name: file_id required: true description: Returns files based on the provided IDs. These files are used for the RTR 'put' command. name: cs-falcon-get-file outputs: - contextPath: CrowdStrike.File.ID description: The ID of the file. type: String - contextPath: CrowdStrike.File.CreatedBy description: The email address of the user who created the file. type: String - contextPath: CrowdStrike.File.CreatedTime description: The datetime the file was created. type: Date - contextPath: CrowdStrike.File.Description description: The description of the file. type: String - contextPath: CrowdStrike.File.Type description: The type of the file. For example, script. type: String - contextPath: CrowdStrike.File.ModifiedBy description: The email address of the user who modified the file. type: String - contextPath: CrowdStrike.File.ModifiedTime description: The datetime the file was modified. type: Date - contextPath: CrowdStrike.File.Name description: The full name of the file. type: String - contextPath: CrowdStrike.File.Permission description: 'The permission type of the file. Possible values are: "private", which is used only by the user who uploaded it, "group", which is used by all RTR Admins, and "public", which is used by all active-responders and RTR admins.' type: String - contextPath: CrowdStrike.File.SHA256 description: The SHA-256 hash of the file. type: String - contextPath: File.Type description: The file type. type: String - contextPath: File.Name description: The full name of the file. type: String - contextPath: File.SHA256 description: The SHA-256 hash of the file. type: String - contextPath: File.Size description: The size of the file in bytes. type: Number - arguments: [] description: Returns a list of put-file IDs that are available for the user in the 'put' command. Due to an API limitation, the maximum number of files returned is 100. name: cs-falcon-list-files outputs: - contextPath: CrowdStrike.File.ID description: The ID of the file. type: String - contextPath: CrowdStrike.File.CreatedBy description: The email address of the user who created the file. type: String - contextPath: CrowdStrike.File.CreatedTime description: The datetime the file was created. type: Date - contextPath: CrowdStrike.File.Description description: The description of the file. type: String - contextPath: CrowdStrike.File.Type description: The type of the file. For example, script. type: String - contextPath: CrowdStrike.File.ModifiedBy description: The email address of the user who modified the file. type: String - contextPath: CrowdStrike.File.ModifiedTime description: The datetime the file was modified. type: Date - contextPath: CrowdStrike.File.Name description: The full name of the file. type: String - contextPath: CrowdStrike.File.Permission description: 'The permission type of the file. Possible values are: "private", which is used only by the user who uploaded it, "group", which is used by all RTR Admins, and "public", which is used by all active-responders and RTR admins.' type: String - contextPath: CrowdStrike.File.SHA256 description: The SHA-256 hash of the file. type: String - contextPath: File.Type description: The file type. type: String - contextPath: File.Name description: The full name of the file. type: String - contextPath: File.SHA256 description: The SHA-256 hash of the file. type: String - contextPath: File.Size description: The size of the file in bytes. type: Number - arguments: - description: A comma-separated list of script IDs to return. The script IDs can be retrieved by running the 'cs-falcon-list-scripts' command. name: script_id required: true description: Returns custom scripts based on the provided ID. Used for the RTR 'runscript' command. name: cs-falcon-get-script outputs: - contextPath: CrowdStrike.Script.ID description: The ID of the script. type: String - contextPath: CrowdStrike.Script.CreatedBy description: The email address of the user who created the script. type: String - contextPath: CrowdStrike.Script.CreatedTime description: The datetime the script was created. type: Date - contextPath: CrowdStrike.Script.Description description: The description of the script. type: String - contextPath: CrowdStrike.Script.ModifiedBy description: The email address of the user who modified the script. type: String - contextPath: CrowdStrike.Script.ModifiedTime description: The datetime the script was modified. type: Date - contextPath: CrowdStrike.Script.Name description: The script name. type: String - contextPath: CrowdStrike.Script.Permission description: 'Permission type of the script. Possible values are: "private", which is used only by the user who uploaded it, "group", which is used by all RTR Admins, and "public", which is used by all active-responders and RTR admins.' type: String - contextPath: CrowdStrike.Script.SHA256 description: The SHA-256 hash of the script file. type: String - contextPath: CrowdStrike.Script.RunAttemptCount description: The number of times the script attempted to run. type: Number - contextPath: CrowdStrike.Script.RunSuccessCount description: The number of times the script ran successfully. type: Number - contextPath: CrowdStrike.Script.Platform description: The list of operating system platforms on which the script can run. For example, Windows. type: String - contextPath: CrowdStrike.Script.WriteAccess description: Whether the user has write access to the script. type: Boolean - arguments: - description: The script ID to delete. The script IDs can be retrieved by running the 'cs-falcon-list-scripts' command. name: script_id required: true description: Deletes a custom-script based on the provided ID. Can delete only one script at a time. name: cs-falcon-delete-script - arguments: [] description: Returns a list of custom script IDs that are available for the user in the 'runscript' command. name: cs-falcon-list-scripts outputs: - contextPath: CrowdStrike.Script.ID description: The ID of the script. type: String - contextPath: CrowdStrike.Script.CreatedBy description: The email address of the user who created the script. type: String - contextPath: CrowdStrike.Script.CreatedTime description: The datetime the script was created. type: Date - contextPath: CrowdStrike.Script.Description description: The description of the script. type: String - contextPath: CrowdStrike.Script.ModifiedBy description: The email address of the user who modified the script. type: String - contextPath: CrowdStrike.Script.ModifiedTime description: The datetime the script was modified. type: Date - contextPath: CrowdStrike.Script.Name description: The script name. type: String - contextPath: CrowdStrike.Script.Permission description: 'Permission type of the script. Possible values are: "private", which is used only by the user who uploaded it, "group", which is used by all RTR Admins, and "public", which is used by all active-responders and RTR admins.' type: String - contextPath: CrowdStrike.Script.SHA256 description: The SHA-256 hash of the script file. type: String - contextPath: CrowdStrike.Script.RunAttemptCount description: The number of times the script attempted to run. type: Number - contextPath: CrowdStrike.Script.RunSuccessCount description: The number of times the script ran successfully. type: Number - contextPath: CrowdStrike.Script.Platform description: The list of operating system platforms on which the script can run. For example, Windows. type: String - contextPath: CrowdStrike.Script.WriteAccess description: Whether the user has write access to the script. type: Boolean - arguments: - description: The name of the script to run. name: script_name - description: A comma-separated list of host agent IDs to run commands. The list of host agent IDs can be retrieved by running the 'cs-falcon-search-device' command. name: host_ids required: true - description: The PowerShell script code to run. name: raw - defaultValue: '30' description: Timeout for how long to wait for the request in seconds. Maximum is 600 (10 minutes). name: timeout - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false description: Runs a script on the agent host. name: cs-falcon-run-script outputs: - contextPath: CrowdStrike.Command.HostID description: The ID of the host for which the command was running. type: String - contextPath: CrowdStrike.Command.SessionID description: The ID of the session of the host. type: String - contextPath: CrowdStrike.Command.Stdout description: The standard output of the command. type: String - contextPath: CrowdStrike.Command.Stderr description: The standard error of the command. type: String - contextPath: CrowdStrike.Command.BaseCommand description: The base command. type: String - contextPath: CrowdStrike.Command.FullCommand description: The full command. type: String - arguments: - description: A comma-separated list of host agent IDs on which to run the RTR command. isArray: true name: host_ids required: true - description: Full path to the file that will be retrieved from each host in the batch. name: file_path required: true - description: A comma-separated list of a subset of hosts on which to run the command. name: optional_hosts isArray: true - description: 'The number of seconds to wait for the request before it times out. In ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' name: timeout - description: 'The amount of time to wait for the request before it times out. In duration syntax. For example, 10s. Valid units are: ns, us, ms, s, m, h. Maximum value is 10 minutes.' name: timeout_duration description: Batch executes 'get' command across hosts to retrieve files. name: cs-falcon-run-get-command outputs: - contextPath: CrowdStrike.Command.HostID description: The ID of the host on which the command was running. type: string - contextPath: CrowdStrike.Command.Stdout description: The standard output of the command. type: string - contextPath: CrowdStrike.Command.Stderr description: The standard error of the command. type: string - contextPath: CrowdStrike.Command.BaseCommand description: The base command. type: string - contextPath: CrowdStrike.Command.TaskID description: The ID of the command that was running on the host. type: string - contextPath: CrowdStrike.Command.GetRequestID description: The ID of the command request that was accepted. type: string - contextPath: CrowdStrike.Command.Complete description: True if the command completed. type: boolean - contextPath: CrowdStrike.Command.FilePath description: The file path. type: string - arguments: - description: A comma-separated list of IDs of the command requested. isArray: true name: request_ids required: true - description: 'The number of seconds to wait for the request before it times out. In ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' name: timeout - description: 'The amount of time to wait for the request before it times out. In duration syntax. For example, 10s. Valid units are: ns, us, ms, s, m, h. Maximum value is 10 minutes.' name: timeout_duration description: Retrieves the status of the specified batch 'get' command. name: cs-falcon-status-get-command outputs: - contextPath: CrowdStrike.File.ID description: The ID of the file. type: string - contextPath: CrowdStrike.File.TaskID description: The ID of the command that is running. type: string - contextPath: CrowdStrike.File.CreatedAt description: The date the file was created. type: date - contextPath: CrowdStrike.File.DeletedAt description: The date the file was deleted. type: date - contextPath: CrowdStrike.File.UpdatedAt description: The date the file was last updated. type: date - contextPath: CrowdStrike.File.Name description: The full name of the file. type: string - contextPath: CrowdStrike.File.SHA256 description: The SHA256 hash of the file. type: string - contextPath: CrowdStrike.File.Size description: The size of the file in bytes. type: number - contextPath: File.Name description: The full name of the file. type: string - contextPath: File.Size description: The size of the file in bytes. type: number - contextPath: File.SHA256 description: The SHA256 hash of the file. type: string - arguments: - description: The ID of the command requested. name: request_id required: true - description: The sequence ID in chunk requests. name: sequence_id - auto: PREDEFINED defaultValue: read description: The scope to run the command for. name: scope predefined: - read - write - admin description: Gets the status of a command executed on a host. name: cs-falcon-status-command outputs: - contextPath: CrowdStrike.Command.TaskID description: The ID of the command request that was accepted. type: string - contextPath: CrowdStrike.Command.Stdout description: The standard output of the command. type: string - contextPath: CrowdStrike.Command.Stderr description: The standard error of the command. type: string - contextPath: CrowdStrike.Command.BaseCommand description: The base command. type: string - contextPath: CrowdStrike.Command.Complete description: True if the command completed. type: boolean - contextPath: CrowdStrike.Command.SequenceID description: The sequence ID in the current request. type: number - contextPath: CrowdStrike.Command.NextSequenceID description: The sequence ID for the next request in the chunk request. type: number - arguments: - description: The host agent ID. name: host_id required: true - description: The SHA256 hash of the file. name: sha256 required: true - description: The filename to use for the archive name and the file within the archive. name: filename description: Gets the RTR extracted file contents for the specified session and SHA256 hash. name: cs-falcon-get-extracted-file - arguments: - description: The ID of the host agent that lists files in the session. name: host_id required: true - description: The ID of the existing session with the agent. name: session_id description: Gets a list of files for the specified RTR session on a host. name: cs-falcon-list-host-files outputs: - contextPath: CrowdStrike.Command.HostID description: The ID of the host the command was running for. type: string - contextPath: CrowdStrike.Command.TaskID description: The ID of the command request that was accepted. type: string - contextPath: CrowdStrike.Command.SessionID description: The ID of the session of the host. type: string - contextPath: CrowdStrike.File.ID description: The ID of the file. type: string - contextPath: CrowdStrike.File.CreatedAt description: The date the file was created. type: date - contextPath: CrowdStrike.File.DeletedAt description: The date the file was deleted. type: date - contextPath: CrowdStrike.File.UpdatedAt description: The date the file was last updated. type: date - contextPath: CrowdStrike.File.Name description: The full name of the file. type: string - contextPath: CrowdStrike.File.SHA256 description: The SHA256 hash of the file. type: string - contextPath: CrowdStrike.File.Size description: The size of the file in bytes. type: number - contextPath: File.Name description: The full name of the file. type: string - contextPath: File.Size description: The size of the file in bytes. type: number - contextPath: File.SHA256 description: The SHA256 hash of the file. type: string - arguments: - description: The ID of the host to extend the session for. name: host_id required: true description: Refresh a session timeout on a single host. name: cs-falcon-refresh-session - arguments: - description: 'A comma-separated list of indicator types. Valid types are: "sha256", "sha1", "md5", "domain", "ipv4", "ipv6".' isArray: true name: types - description: A comma-separated list of indicator values. isArray: true name: values - description: A comma-separated list of indicator policies. isArray: true name: policies - description: The level the indicator will be shared at. Only "red" share level (not shared) is supported, which indicates that the IOC is not shared with other CrowdStrike Falcon Host customers. isArray: true name: share_levels - description: A comma-separated list of IOC sources. isArray: true name: sources - description: Start of date range to search in YYYY-MM-DD format. name: from_expiration_date - description: End of date range to search in YYYY-MM-DD format. name: to_expiration_date - description: The maximum number of records to return. The minimum is 1 and the maximum is 500. Default is 100. name: limit - auto: PREDEFINED description: The order the results are returned in. name: sort predefined: - type.asc - type.desc - value.asc - value.desc - policy.asc - policy.desc - share_level.asc - share_level.desc - expiration_timestamp.asc - expiration_timestamp.desc - description: The offset to begin the list from. For example, start from the 10th record and return the list. name: offset deprecated: true description: Deprecated. Use the cs-falcon-search-custom-iocs command instead. name: cs-falcon-search-iocs outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator (type:value). type: string - contextPath: CrowdStrike.IOC.Policy description: The policy of the indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.ShareLevel description: The level at which the indicator will be shared. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: string - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: string - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - arguments: - auto: PREDEFINED description: The IOC type to retrieve. name: type predefined: - sha256 - sha1 - md5 - domain - ipv4 - ipv6 required: true - description: The string representation of the indicator. name: value required: true deprecated: true description: Deprecated. Use the cs-falcon-get-custom-ioc command instead. name: cs-falcon-get-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator (type:value). type: string - contextPath: CrowdStrike.IOC.Policy description: The policy of the indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.ShareLevel description: The level at which the indicator will be shared. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime when the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: string - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: string - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - arguments: - auto: PREDEFINED description: The type of the indicator. name: ioc_type predefined: - sha256 - md5 - domain - ipv4 - ipv6 required: true - description: The string representation of the indicator. name: value required: true - auto: PREDEFINED defaultValue: detect description: 'The policy to enact when the value is detected on a host. A value of "none" is equivalent to turning the indicator off.' name: policy predefined: - detect - none - auto: PREDEFINED description: The level the indicator will be shared at. Only "red" share level (not shared) is supported, which indicates that the IOC is not shared with other Falcon Host customers. name: share_level predefined: - red - description: The number of days the indicator should be valid for. This only applies to domain, ipv4, and ipv6 types. name: expiration_days - description: The source where this indicator originated. This can be used for tracking where this indicator was defined. Limited to 200 characters. name: source - description: A meaningful description of the indicator. Limited to 200 characters. name: description deprecated: true description: Deprecated. Use the cs-falcon-upload-custom-ioc command instead. name: cs-falcon-upload-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator (type:value). type: string - contextPath: CrowdStrike.IOC.Policy description: The policy of the indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.ShareLevel description: The level at which the indicator will be shared. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: string - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: string - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - arguments: - auto: PREDEFINED description: The type of the indicator. name: ioc_type predefined: - sha256 - md5 - sha1 - domain - ipv4 - ipv6 required: true - description: The string representation of the indicator. name: value required: true - auto: PREDEFINED defaultValue: detect description: 'The policy to enact when the value is detected on a host. A value of "none" is equivalent to turning the indicator off.' name: policy predefined: - detect - none - auto: PREDEFINED description: The level the indicator will be shared at. Only "red" share level (not shared) is supported, which indicates that the IOC is not shared with other Falcon Host customers. name: share_level predefined: - red - description: The number of days the indicator should be valid for. This only applies to domain, ipv4, and ipv6 types. name: expiration_days - description: The source where this indicator originated. This can be used for tracking where this indicator was defined. Limited to 200 characters. name: source - description: A meaningful description of the indicator. Limited to 200 characters. name: description deprecated: true description: Deprecated. Use the cs-falcon-update-custom-ioc command instead. name: cs-falcon-update-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator (type:value). type: string - contextPath: CrowdStrike.IOC.Policy description: The policy of the indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.ShareLevel description: The level at which the indicator will be shared. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: string - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: string - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - arguments: - auto: PREDEFINED description: The IOC type to delete. name: type predefined: - sha256 - sha1 - md5 - domain - ipv4 - ipv6 required: true - description: The string representation of the indicator. name: value required: true deprecated: true description: Deprecated. Use the cs-falcon-delete-custom-ioc command instead. name: cs-falcon-delete-ioc - arguments: - auto: PREDEFINED description: A comma-separated list of indicator types. isArray: true name: types predefined: - sha256 - sha1 - md5 - domain - ipv4 - ipv6 - description: A comma-separated list of indicator values. isArray: true name: values - description: A comma-separated list of IOC sources. isArray: true name: sources - description: The datetime the indicator will become inactive (ISO 8601 format, i.e., YYYY-MM-DDThh:mm:ssZ). name: expiration - defaultValue: '50' description: The maximum number of records to return. The minimum is 1 and the maximum is 500. name: limit - auto: PREDEFINED description: The order the results are returned in. name: sort predefined: - type.asc - type.desc - value.asc - value.desc - policy.asc - policy.desc - share_level.asc - share_level.desc - expiration_timestamp.asc - expiration_timestamp.desc - description: The offset to begin the list from. For example, start from the 10th record and return the list. name: offset - description: A pagination token used with the limit parameter to manage pagination of results. Matching the 'after' parameter in the API. Use instead of offset. name: next_page_token description: Returns a list of your uploaded IOCs that match the search criteria. name: cs-falcon-search-custom-iocs outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator. type: string - contextPath: CrowdStrike.IOC.Severity description: The severity level to apply to this indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.Action description: Action to take when a host observes the custom IOC. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: date - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: date - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - contextPath: CrowdStrike.IOC.MobileAction description: The action to take on mobile devices when a host observes the custom IOC. type: string - contextPath: CrowdStrike.NextPageToken description: A pagination token used with the limit parameter to manage pagination of results. - arguments: - auto: PREDEFINED description: The IOC type to retrieve. Either ioc_id or ioc_type and value must be provided. name: type predefined: - sha256 - sha1 - md5 - domain - ipv4 - ipv6 - description: The string representation of the indicator. Either ioc_id or ioc_type and value must be provided. name: value - description: The ID of the IOC to get. The ID of the IOC can be retrieved by running the 'cs-falcon-search-custom-iocs' command. Either ioc_id or ioc_type and value must be provided. name: ioc_id description: Gets the full definition of one or more indicators that you are watching. name: cs-falcon-get-custom-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator. type: string - contextPath: CrowdStrike.IOC.Severity description: The severity level to apply to this indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.Action description: Action to take when a host observes the custom IOC. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime when the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: date - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: date - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - contextPath: CrowdStrike.IOC.MobileAction description: The action to take on mobile devices when a host observes the custom IOC. type: string - arguments: - auto: PREDEFINED description: The type of the indicator. name: ioc_type predefined: - sha256 - md5 - domain - ipv4 - ipv6 required: true - description: |- A comma-separated list of indicators. More than one value can be supplied to upload multiple IOCs of the same type but with different values. Note that the uploaded IOCs will have the same properties (as supplied in other arguments). isArray: true name: value required: true - auto: PREDEFINED description: 'Action to take when a host observes the custom IOC. Possible values are: no_action - Save the indicator for future use, but take no action. No severity required. allow - Applies to hashes only. Allow the indicator and do not detect it. Severity does not apply and should not be provided. prevent_no_ui - Applies to hashes only. Block and detect the indicator, but hide it from Activity > Detections. Has a default severity value. prevent - Applies to hashes only. Block the indicator and show it as a detection at the selected severity. detect - Enable detections for the indicator at the selected severity.' name: action predefined: - no_action - allow - prevent_no_ui - prevent - detect required: true - auto: PREDEFINED description: A comma-separated list of the platforms that the indicator applies to. isArray: true name: platforms predefined: - mac - windows - linux - android - ios required: true - auto: PREDEFINED description: The severity level to apply to this indicator. Required for the prevent and detect actions. Optional for no_action. name: severity predefined: - informational - low - medium - high - critical - description: The datetime the indicator will become inactive (ISO 8601 format, i.e., YYYY-MM-DDThh:mm:ssZ). name: expiration - description: The source where this indicator originated. This can be used for tracking where this indicator was defined. Limited to 200 characters. name: source - description: A meaningful description of the indicator. Limited to 200 characters. name: description - auto: PREDEFINED description: Whether the indicator is applied globally. Either applied_globally or host_groups must be provided. name: applied_globally predefined: - 'true' - 'false' - description: A comma-separated list of host group IDs that the indicator applies to. The list of host group IDs can be retrieved by running the 'cs-falcon-list-host-groups' command. Either applied_globally or host_groups must be provided. isArray: true name: host_groups - description: A comma-separated list of tags to apply to the indicator. isArray: true name: tags - description: Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. name: file_name - auto: PREDEFINED description: |- The action to take on mobile devices when a host observes the custom IOC. Note: To use this argument, a mobile platform (android or ios) must be included in the platforms argument. - no_action: The indicator is saved for future use, but no action is taken (no severity required). - allow: The indicator is allowed and not detected (severity does not apply and should not be provided). - detect: The connection is allowed and a detection is generated. - prevent: The indicator is blocked and shown as a detection. name: mobile_action predefined: - no_action - allow - detect - prevent description: Uploads an indicator for CrowdStrike to monitor. name: cs-falcon-upload-custom-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator. type: string - contextPath: CrowdStrike.IOC.Severity description: The severity level to apply to this indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.Action description: Action to take when a host observes the custom IOC. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime when the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: date - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: date - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - contextPath: CrowdStrike.IOC.Tags description: The tags of the IOC. type: Unknown - contextPath: CrowdStrike.IOC.Platforms description: The platforms of the IOC. type: Unknown - contextPath: CrowdStrike.IOC.Filename description: Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. type: string - contextPath: CrowdStrike.IOC.MobileAction description: The action to take on mobile devices when a host observes the custom IOC. type: string compliantpolicies: - Domain Blockage - IP Blockage - arguments: - description: The ID of the IOC to update. The ID of the IOC can be retrieved by running the 'cs-falcon-search-custom-iocs' command. name: ioc_id required: true - auto: PREDEFINED description: 'Action to take when a host observes the custom IOC. Possible values are: no_action - Save the indicator for future use, but take no action. No severity required. allow - Applies to hashes only. Allow the indicator and do not detect it. Severity does not apply and should not be provided. prevent_no_ui - Applies to hashes only. Block and detect the indicator, but hide it from Activity > Detections. Has a default severity value. prevent - Applies to hashes only. Block the indicator and show it as a detection at the selected severity. detect - Enable detections for the indicator at the selected severity.' name: action predefined: - no_action - allow - prevent_no_ui - prevent - detect - auto: PREDEFINED description: A comma-separated list of the platforms that the indicator applies to. name: platforms predefined: - mac - windows - linux - auto: PREDEFINED description: The severity level to apply to this indicator. Required for the prevent and detect actions. Optional for no_action. name: severity predefined: - informational - low - medium - high - critical - description: The datetime the indicator will become inactive (ISO 8601 format, i.e., YYYY-MM-DDThh:mm:ssZ). name: expiration - description: The source where this indicator originated. This can be used for tracking where this indicator was defined. Limited to 200 characters. name: source - description: A meaningful description of the indicator. Limited to 200 characters. name: description - description: Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. name: file_name - auto: PREDEFINED description: |- The action to take on mobile devices when a host observes the custom IOC. Note: To use this argument, a mobile platform (android or ios) must be included in the platforms argument. - no_action: The indicator is saved for future use, but no action is taken (no severity required). - allow: The indicator is allowed and not detected (severity does not apply and should not be provided). - detect: The connection is allowed and a detection is generated. - prevent: The indicator is blocked and shown as a detection. name: mobile_action predefined: - no_action - allow - detect - prevent description: Updates an indicator for CrowdStrike to monitor. name: cs-falcon-update-custom-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator. type: string - contextPath: CrowdStrike.IOC.Severity description: The severity level to apply to this indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.Action description: Action to take when a host observes the custom IOC. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime when the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: date - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: date - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - contextPath: CrowdStrike.IOC.Filename description: Name of the file for file indicators. Applies to hashes only. A common filename, or a filename in your environment. Filenames can be helpful for identifying hashes or filtering IOCs. type: string - contextPath: CrowdStrike.IOC.MobileAction description: The action to take on mobile devices when a host observes the custom IOC. type: string - arguments: - description: The ID of the IOC to delete. The ID of the IOC can be retrieved by running the 'cs-falcon-search-custom-iocs' command. name: ioc_id required: true description: Deletes a monitored indicator. name: cs-falcon-delete-custom-ioc - arguments: - auto: PREDEFINED description: The IOC type. name: type predefined: - sha256 - sha1 - md5 - domain - ipv4 - ipv6 required: true - description: The string representation of the indicator. name: value required: true description: The number of hosts that observed the provided IOC. name: cs-falcon-device-count-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator (type:value). type: string - contextPath: CrowdStrike.IOC.DeviceCount description: The number of devices the IOC ran on. type: number - arguments: - auto: PREDEFINED description: The IOC type. name: type predefined: - sha256 - sha1 - md5 - domain - ipv4 - ipv6 required: true - description: The string representation of the indicator. name: value required: true - description: The device ID to check against. name: device_id required: true description: Get processes associated with a given IOC. name: cs-falcon-processes-ran-on outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator (type:value). type: string - contextPath: CrowdStrike.IOC.Process.ID description: The processes IDs associated with the given IOC. type: number - contextPath: CrowdStrike.IOC.Process.DeviceID description: The device the process ran on. type: number - arguments: - default: true description: A comma-separated list of process IDs. isArray: true name: ids required: true description: Retrieves the details of a process, according to the process ID that is running or that previously ran. name: cs-falcon-process-details outputs: - contextPath: CrowdStrike.Process.process_id description: The process ID. type: String - contextPath: CrowdStrike.Process.process_id_local description: Local ID of the process. type: String - contextPath: CrowdStrike.Process.device_id description: The device the process ran on. type: String - contextPath: CrowdStrike.Process.file_name description: The path of the file that ran the process. type: String - contextPath: CrowdStrike.Process.command_line description: The command line command execution. type: String - contextPath: CrowdStrike.Process.start_timestamp_raw description: 'The start datetime of the process in Unix time format. For example: 132460167512852140.' type: String - contextPath: CrowdStrike.Process.start_timestamp description: 'The start datetime of the process in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: String - contextPath: CrowdStrike.Process.stop_timestamp_raw description: 'The stop datetime of the process in Unix time format. For example: 132460167512852140.' type: Date - contextPath: CrowdStrike.Process.stop_timestamp description: 'The stop datetime of the process in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - arguments: - auto: PREDEFINED description: 'The type of indicator.' name: type predefined: - domain - ipv4 - ipv6 - md5 - sha1 - sha256 required: true - description: The string representation of the indicator. name: value required: true deprecated: true description: Returns a list of device IDs an indicator ran on. name: cs-device-ran-on outputs: - contextPath: CrowdStrike.DeviceIOC.DeviceID description: The device IDs an indicator ran on. type: string - contextPath: CrowdStrike.DeviceIOC.ID description: The indicator ID. type: string - contextPath: CrowdStrike.DeviceIOC.Type description: The indicator type. type: string - contextPath: CrowdStrike.DeviceIOC.Value description: The indicator value. type: string - arguments: - auto: PREDEFINED description: The type of indicator. name: type predefined: - domain - ipv4 - ipv6 - md5 - sha1 - sha256 required: true - description: The string representation of the indicator. name: value required: true description: Returns a list of device IDs an indicator ran on. name: cs-falcon-device-ran-on outputs: - contextPath: CrowdStrike.DeviceID description: Device IDs an indicator ran on. type: string - arguments: - description: The query used to filter the results. name: fetch_query - description: A comma-separated list of detection IDs. For example, ldt:1234:1234,ldt:5678:5678. If you use this argument, the fetch_query argument will be ignored. isArray: true name: ids description: Lists detection summaries. name: cs-falcon-list-detection-summaries outputs: - contextPath: CrowdStrike.Detections.cid description: The organization's customer ID (CID). type: String - contextPath: CrowdStrike.Detections.created_timestamp description: 'The datetime the detection occurred in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.Detections.detection_id description: The ID of the detection. type: String - contextPath: CrowdStrike.Detections.device.device_id description: The device ID as seen by CrowdStrike Falcon. type: String - contextPath: CrowdStrike.Detections.device.cid description: The CrowdStrike Customer ID (CID) to which the device belongs. type: String - contextPath: CrowdStrike.Detections.device.agent_load_flags description: The CrowdStrike Falcon agent load flags. type: String - contextPath: CrowdStrike.Detections.device.agent_local_time description: The local time of the sensor. type: Date - contextPath: CrowdStrike.Detections.device.agent_version description: 'The version of the agent that the device is running. For example: 5.32.11406.0.' type: String - contextPath: CrowdStrike.Detections.device.bios_manufacturer description: The BIOS manufacturer. type: String - contextPath: CrowdStrike.Detections.device.bios_version description: The device's BIOS version. type: String - contextPath: CrowdStrike.Detections.device.config_id_base description: The base of the sensor that the device is running. type: String - contextPath: CrowdStrike.Detections.device.config_id_build description: 'The version of the sensor that the device is running. For example: 11406.' type: String - contextPath: CrowdStrike.Detections.device.config_id_platform description: The platform ID of the sensor that the device is running. type: String - contextPath: CrowdStrike.Detections.device.external_ip description: The external IP address of the device. type: String - contextPath: CrowdStrike.Detections.device.hostname description: The hostname of the device. type: String - contextPath: CrowdStrike.Detections.device.first_seen description: The datetime the host was first seen by CrowdStrike Falcon. type: Date - contextPath: CrowdStrike.Detections.device.last_seen description: The datetime the host was last seen by CrowdStrike Falcon. type: Date - contextPath: CrowdStrike.Detections.device.local_ip description: The local IP address of the device. type: String - contextPath: CrowdStrike.Detections.device.mac_address description: The MAC address of the device. type: String - contextPath: CrowdStrike.Detections.device.major_version description: The major version of the operating system. type: String - contextPath: CrowdStrike.Detections.device.minor_version description: The minor version of the operating system. type: String - contextPath: CrowdStrike.Detections.device.os_version description: The operating system of the device. type: String - contextPath: CrowdStrike.Detections.device.platform_id description: The platform ID of the device that runs the sensor. type: String - contextPath: CrowdStrike.Detections.device.platform_name description: The platform name of the device. type: String - contextPath: CrowdStrike.Detections.device.product_type_desc description: The value indicating the product type. For example, 1 = Workstation, 2 = Domain Controller, 3 = Server. type: String - contextPath: CrowdStrike.Detections.device.status description: 'The containment status of the machine. Possible values are: "normal", "containment_pending", "contained", and "lift_containment_pending".' type: String - contextPath: CrowdStrike.Detections.device.system_manufacturer description: The system manufacturer of the device. type: String - contextPath: CrowdStrike.Detections.device.system_product_name description: The product name of the system. type: String - contextPath: CrowdStrike.Detections.device.modified_timestamp description: 'The datetime the device was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.Detections.behaviors.device_id description: The ID of the device associated with the behavior. type: String - contextPath: CrowdStrike.Detections.behaviors.timestamp description: 'The datetime the behavior detection occurred in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.Detections.behaviors.filename description: The filename of the triggering process. type: String - contextPath: CrowdStrike.Detections.behaviors.alleged_filetype description: The file extension of the behavior's filename. type: String - contextPath: CrowdStrike.Detections.behaviors.cmdline description: The command line of the triggering process. type: String - contextPath: CrowdStrike.Detections.behaviors.scenario description: The name of the scenario the behavior belongs to. type: String - contextPath: CrowdStrike.Detections.behaviors.objective description: The name of the objective associated with the behavior. type: String - contextPath: CrowdStrike.Detections.behaviors.tactic description: The name of the tactic associated with the behavior. type: String - contextPath: CrowdStrike.Detections.behaviors.technique description: The name of the technique associated with the behavior. type: String - contextPath: CrowdStrike.Detections.behaviors.severity description: The severity rating for the behavior. The value can be any integer between 1-100. type: Number - contextPath: CrowdStrike.Detections.behaviors.confidence description: The true positive confidence rating for the behavior. The value can be any integer between 1-100. type: Number - contextPath: CrowdStrike.Detections.behaviors.ioc_type description: 'The type of the triggering IOC. Possible values are: "hash_sha256", "hash_md5", "domain", "filename", "registry_key", "command_line", and "behavior".' type: String - contextPath: CrowdStrike.Detections.behaviors.ioc_value description: The IOC value. type: String - contextPath: CrowdStrike.Detections.behaviors.user_name description: The user name. type: String - contextPath: CrowdStrike.Detections.behaviors.user_id description: The Security Identifier (SID) of the user in Windows. type: String - contextPath: CrowdStrike.Detections.behaviors.control_graph_id description: The behavior hit key for the Threat Graph API. type: String - contextPath: CrowdStrike.Detections.behaviors.triggering_process_graph_id description: The ID of the process that triggered the behavior detection. type: String - contextPath: CrowdStrike.Detections.behaviors.sha256 description: The SHA256 of the triggering process. type: String - contextPath: CrowdStrike.Detections.behaviors.md5 description: The MD5 hash of the triggering process. type: String - contextPath: CrowdStrike.Detections.behaviors.parent_details.parent_sha256 description: The SHA256 hash of the parent process. type: String - contextPath: CrowdStrike.Detections.behaviors.parent_details.parent_md5 description: The MD5 hash of the parent process. type: String - contextPath: CrowdStrike.Detections.behaviors.parent_details.parent_cmdline description: The command line of the parent process. type: String - contextPath: CrowdStrike.Detections.behaviors.parent_details.parent_process_graph_id description: The process graph ID of the parent process. type: String - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition description: The pattern associated with the action performed on the behavior. type: Number - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.indicator description: Whether the detection behavior is similar to an indicator. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.detect description: Whether this behavior is detected. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.inddet_mask description: Whether this behavior is an inddet mask. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.sensor_only description: Whether this detection is sensor only. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.rooting description: Whether this behavior is rooting. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.kill_process description: Whether this detection kills the process. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.kill_subprocess description: Whether this detection kills the subprocess. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.quarantine_machine description: Whether this detection was on a quarantined machine. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.quarantine_file description: Whether this detection was on a quarantined file. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.policy_disabled description: Whether this policy is disabled. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.kill_parent description: Whether this detection kills the parent process. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.operation_blocked description: Whether the operation is blocked. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.process_blocked description: Whether the process is blocked. type: Boolean - contextPath: CrowdStrike.Detections.behaviors.pattern_disposition_details.registry_operation_blocked description: Whether the registry operation is blocked. type: Boolean - contextPath: CrowdStrike.Detections.email_sent description: Whether an email is sent about this detection. type: Boolean - contextPath: CrowdStrike.Detections.show_in_ui description: Whether the detection displays in the UI. type: Boolean - contextPath: CrowdStrike.Detections.status description: The status of the detection. type: String - contextPath: CrowdStrike.Detections.hostinfo.domain description: The domain of the Active Directory. type: String - contextPath: CrowdStrike.Detections.seconds_to_triaged description: The amount of time it took to move a detection from "new" to "in_progress". type: Number - contextPath: CrowdStrike.Detections.seconds_to_resolved description: The amount of time it took to move a detection from new to a resolved state ("true_positive", "false_positive", and "ignored"). type: Number - arguments: - description: A comma-separated list of case IDs. isArray: true name: ids description: Lists case summaries. name: cs-falcon-list-case-summaries outputs: - contextPath: CrowdStrike.Case.id description: The ID of the case. type: String - contextPath: CrowdStrike.Case.name description: The name of the case. type: String - contextPath: CrowdStrike.Case.created_timestamp description: The date and time the case was created. type: Date - contextPath: CrowdStrike.Case.status description: The status of the case. type: String - contextPath: CrowdStrike.Case.version description: The version of the case. type: String - contextPath: CrowdStrike.Case.description description: The description of the case. type: String - contextPath: CrowdStrike.Case.severity description: The severity of the case. type: String - contextPath: CrowdStrike.Case.assigned_to description: The name of the user assigned to the case. type: String - contextPath: CrowdStrike.Case.tags description: The tags of the case. type: String - arguments: - description: The ID of the case to retrieve evidence for. name: id required: true description: Get evidence for a specific case. name: cs-falcon-get-evidence-for-case outputs: - contextPath: CrowdStrike.CaseEvidence.alerts description: The alerts associated with the case. type: Array - contextPath: CrowdStrike.CaseEvidence.events description: The events associated with the case. type: Array - contextPath: CrowdStrike.CaseEvidence.leads description: The leads associated with the case. type: Array - arguments: - description: A comma-separated list of tags. isArray: true name: tags required: true - description: The ID of the case the tags will be added to. name: id required: true description: Adds tags to the specified case. name: cs-falcon-add-case-tag - arguments: - description: The ID of the case the tags will be deleted from. name: id required: true - description: The tag to delete. name: tag required: true description: Deletes a tag from the specified case. name: cs-falcon-delete-case-tag - arguments: - description: The ID of the case to resolve. name: id required: true - description: The status to set for the case. name: status auto: PREDEFINED predefined: - new - in_progress - closed - reopened - description: A UUID of a user to assign the case to. name: assigned_to_uuid - description: A new description for the case. name: description - description: "Whether to remove case assignment from the current user.\nIf set to true and assigned_to_uuid is not provided, the case becomes unassigned.\nIf set to false and assigned_to_uuid is provided, the case is reassigned to the specified user UUID.\nIf set to true and assigned_to_uuid is provided, the case is reassigned to the specified user UUID.\nIf this field is omitted and assigned_to_uuid is provided, the case is reassigned to the specified user UUID." name: remove_user_assignment auto: PREDEFINED predefined: - 'true' - 'false' defaultValue: 'false' - description: The new case severity rating (10-100). name: severity - description: The unique ID of the template to apply to the case. name: template_id - description: The new name for the case. name: name description: Resolves or updates a case. name: cs-falcon-resolve-case - arguments: - description: The endpoint ID. name: id - default: true description: The endpoint IP address. name: ip - description: The endpoint hostname. name: hostname description: Returns information about an endpoint. Does not support regex. name: endpoint outputs: - contextPath: Endpoint.Hostname description: The endpoint's hostname. type: String - contextPath: Endpoint.OS description: The endpoint's operation system. type: String - contextPath: Endpoint.IPAddress description: The endpoint's IP address. type: String - contextPath: Endpoint.ID description: The endpoint's ID. type: String - contextPath: Endpoint.Status description: The endpoint's status. type: String - contextPath: Endpoint.IsIsolated description: The endpoint's isolation status. type: String - contextPath: Endpoint.MACAddress description: The endpoint's MAC address. type: String - contextPath: Endpoint.Vendor description: The integration name of the endpoint vendor. type: String - contextPath: Endpoint.OSVersion description: The endpoint's operation system version. type: String - arguments: - description: The name of the host. name: name required: true - auto: PREDEFINED description: The group type of the group. name: group_type predefined: - static - dynamic required: true - description: The description of the host. name: description - description: The assignment rule. name: assignment_rule description: Create a host group. name: cs-falcon-create-host-group outputs: - contextPath: CrowdStrike.HostGroup.id description: The ID of the host group. type: String - contextPath: CrowdStrike.HostGroup.group_type description: The group type of the host group. type: String - contextPath: CrowdStrike.HostGroup.name description: The name of the host group. type: String - contextPath: CrowdStrike.HostGroup.description description: The description of the host group. type: String - contextPath: CrowdStrike.HostGroup.created_by description: The client that created the host group. type: String - contextPath: CrowdStrike.HostGroup.created_timestamp description: 'The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.HostGroup.modified_by description: The client that modified the host group. type: String - contextPath: CrowdStrike.HostGroup.modified_timestamp description: 'The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - arguments: - description: The query by which to filter the devices that belong to the host group. name: filter - description: Page offset. name: offset - default: true defaultValue: '50' description: Maximum number of results on a page. name: limit type: string description: List the available host groups. name: cs-falcon-list-host-groups outputs: - contextPath: CrowdStrike.HostGroup.id description: The ID of the host group. type: String - contextPath: CrowdStrike.HostGroup.group_type description: The group type of the host group. type: String - contextPath: CrowdStrike.HostGroup.name description: The name of the host group. type: String - contextPath: CrowdStrike.HostGroup.description description: The description of the host group. type: String - contextPath: CrowdStrike.HostGroup.created_by description: The client that created the host group. type: String - contextPath: CrowdStrike.HostGroup.created_timestamp description: 'The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.HostGroup.modified_by description: The client that modified the host group. type: String - contextPath: CrowdStrike.HostGroup.modified_timestamp description: 'The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - arguments: - description: A comma-separated list of the IDs of the host groups to be deleted. isArray: true name: host_group_id required: true description: Deletes the requested host groups. name: cs-falcon-delete-host-groups - arguments: - description: The ID of the host group. name: host_group_id required: true - description: The name of the host group. name: name - description: The description of the host group. name: description - description: The assignment rule. name: assignment_rule description: Updates a host group. name: cs-falcon-update-host-group outputs: - contextPath: CrowdStrike.HostGroup.id description: The ID of the host group. type: String - contextPath: CrowdStrike.HostGroup.group_type description: The group type of the host group. type: String - contextPath: CrowdStrike.HostGroup.name description: The name of the host group. type: String - contextPath: CrowdStrike.HostGroup.description description: The description of the host group. type: String - contextPath: CrowdStrike.HostGroup.created_by description: The client that created the host group. type: String - contextPath: CrowdStrike.HostGroup.created_timestamp description: 'The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.HostGroup.modified_by description: The client that modified the host group. type: String - contextPath: CrowdStrike.HostGroup.modified_timestamp description: 'The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - arguments: - description: The ID of the host group. name: host_group_id - description: The query to filter the devices that belong to the host group. name: filter - description: Page offset. name: offset - default: true defaultValue: '50' description: The maximum number of results on a page. name: limit - description: The property to sort by (e.g., status.desc or hostname.asc). name: sort description: Gets the list of host group members. name: cs-falcon-list-host-group-members outputs: - contextPath: CrowdStrike.Device.ID description: The ID of the device. type: String - contextPath: CrowdStrike.Device.LocalIP description: The local IP address of the device. type: String - contextPath: CrowdStrike.Device.ExternalIP description: The external IP address of the device. type: String - contextPath: CrowdStrike.Device.Hostname description: The hostname of the device. type: String - contextPath: CrowdStrike.Device.OS description: The operating system of the device. type: String - contextPath: CrowdStrike.Device.MacAddress description: The MAC address of the device. type: String - contextPath: CrowdStrike.Device.FirstSeen description: The first time the device was seen. type: String - contextPath: CrowdStrike.Device.LastSeen description: The last time the device was seen. type: String - contextPath: CrowdStrike.Device.Status description: The device status. type: String - arguments: - description: The ID of the host group. name: host_group_id required: true - description: A comma-separated list of host agent IDs to run commands. The list of host agent IDs can be retrieved by running the 'cs-falcon-search-device' command. isArray: true name: host_ids required: true description: Add host group members. name: cs-falcon-add-host-group-members outputs: - contextPath: CrowdStrike.HostGroup.id description: The ID of the host group. type: String - contextPath: CrowdStrike.HostGroup.group_type description: The group type of the host group. type: String - contextPath: CrowdStrike.HostGroup.name description: The name of the host group. type: String - contextPath: CrowdStrike.HostGroup.description description: The description of the host group. type: String - contextPath: CrowdStrike.HostGroup.created_by description: The client that created the host group. type: String - contextPath: CrowdStrike.HostGroup.created_timestamp description: 'The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.HostGroup.modified_by description: The client that modified the host group. type: String - contextPath: CrowdStrike.HostGroup.modified_timestamp description: 'The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - arguments: - description: The ID of the host group. name: host_group_id required: true - description: A comma-separated list of host agent IDs to run commands. The list of host agent IDs can be retrieved by running the 'cs-falcon-search-device' command. isArray: true name: host_ids required: true description: Remove host group members. name: cs-falcon-remove-host-group-members outputs: - contextPath: CrowdStrike.HostGroup.id description: The ID of the host group. type: String - contextPath: CrowdStrike.HostGroup.group_type description: The group type of the host group. type: String - contextPath: CrowdStrike.HostGroup.name description: The name of the host group. type: String - contextPath: CrowdStrike.HostGroup.description description: The description of the host group. type: String - contextPath: CrowdStrike.HostGroup.created_by description: The client that created the host group. type: String - contextPath: CrowdStrike.HostGroup.created_timestamp description: 'The datetime the host group was created in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - contextPath: CrowdStrike.HostGroup.modified_by description: The client that modified the host group. type: String - contextPath: CrowdStrike.HostGroup.modified_timestamp description: 'The datetime the host group was last modified in ISO time format. For example: 2019-10-17T13:41:48.487520845Z.' type: Date - arguments: - description: A JSON object with a list of CrowdStrike Falcon indicators to upload. isArray: true name: multiple_indicators_json required: true - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. defaultValue: "180" type: unknown description: Uploads a batch of indicators. name: cs-falcon-batch-upload-custom-ioc outputs: - contextPath: CrowdStrike.IOC.Type description: The type of the IOC. type: string - contextPath: CrowdStrike.IOC.Value description: The string representation of the indicator. type: string - contextPath: CrowdStrike.IOC.ID description: The full ID of the indicator. type: string - contextPath: CrowdStrike.IOC.Severity description: The severity level to apply to this indicator. type: string - contextPath: CrowdStrike.IOC.Source description: The source of the IOC. type: string - contextPath: CrowdStrike.IOC.Action description: The action to take when a host observes the custom IOC. type: string - contextPath: CrowdStrike.IOC.Expiration description: The datetime the indicator will expire. type: string - contextPath: CrowdStrike.IOC.Description description: The description of the IOC. type: string - contextPath: CrowdStrike.IOC.CreatedTime description: The datetime the IOC was created. type: date - contextPath: CrowdStrike.IOC.CreatedBy description: The identity of the user/process who created the IOC. type: string - contextPath: CrowdStrike.IOC.ModifiedTime description: The datetime the indicator was last modified. type: date - contextPath: CrowdStrike.IOC.ModifiedBy description: The identity of the user/process who last updated the IOC. type: string - contextPath: CrowdStrike.IOC.Tags description: The tags of the IOC. type: Unknown - contextPath: CrowdStrike.IOC.Platforms description: The platforms of the IOC. type: Unknown - contextPath: CrowdStrike.IOC.MobileAction description: The action to take on mobile devices when a host observes the custom IOC. type: string - arguments: - description: The host ID to kill the given process for. name: host_id required: true - description: A comma-separated list of process IDs to kill. isArray: true name: process_ids required: true - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. description: Execute an active responder kill command on a single host. name: cs-falcon-rtr-kill-process outputs: - contextPath: CrowdStrike.Command.kill.ProcessID description: The process ID that was killed. type: String - contextPath: CrowdStrike.Command.kill.Error description: The error message raised if the command failed. type: String - contextPath: CrowdStrike.Command.kill.HostID description: The host ID. type: String - arguments: - description: A comma-separated list of the hosts IDs to remove the file for. isArray: true name: host_ids required: true - description: The path to a file or a directory to remove. name: file_path required: true - auto: PREDEFINED description: The operating system of the hosts given. Since the remove command is different in each operating system, you can choose only one operating system. name: os predefined: - Windows - Linux - Mac required: true - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. description: Batch executes an RTR active-responder remove file across the hosts mapped to the given batch ID. name: cs-falcon-rtr-remove-file outputs: - contextPath: CrowdStrike.Command.rm.HostID description: The host ID. type: String - contextPath: CrowdStrike.Command.rm.Error description: The error message raised if the command failed. type: String - arguments: - description: The host ID to get the processes list from. name: host_id required: true - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. description: Executes an RTR active-responder ps command to get a list of active processes across the given host. name: cs-falcon-rtr-list-processes outputs: - contextPath: CrowdStrike.Command.ps.Filename description: The name of the result file to be returned. type: String - arguments: - description: The host ID to get the network status and protocol statistics list from. name: host_id required: true - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. description: Executes an RTR active-responder netstat command to get a list of network status and protocol statistics across the given host. name: cs-falcon-rtr-list-network-stats outputs: - contextPath: CrowdStrike.Command.netstat.Filename description: The name of the result file to be returned. type: String - arguments: - description: A comma-separated list of the host IDs to get the registry keys from. isArray: true name: host_ids required: true - description: A comma-separated list of the registry keys, sub-keys, or value to get. isArray: true name: registry_keys required: true - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. description: Executes an RTR active-responder read registry keys command across the given hosts. This command is valid only for Windows hosts. name: cs-falcon-rtr-read-registry - arguments: - description: A comma-separated list of the hosts IDs to get the list of scheduled tasks from. isArray: true name: host_ids required: true - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. description: Executes an RTR active-responder netstat command to get a list of scheduled tasks across the given host. This command is valid only for Windows hosts. name: cs-falcon-rtr-list-scheduled-tasks - arguments: - description: A comma-separated list of the hosts IDs to get the file from. isArray: true name: host_ids required: true - description: The file path of the required file to extract. name: file_path required: true - description: The filename to use for the archive name and the file within the archive. name: filename - description: Interval between polling. Default is 60 seconds. Must be higher than 10. name: interval_in_seconds - description: This is an internal argument used for the polling process, not to be used by the user. isArray: true name: hosts_and_requests_ids - description: This is an internal argument used for the polling process, not to be used by the user. isArray: true name: SHA256 - description: Whether the command will run against an offline-queued session and be queued for execution when the host comes online. name: queue_offline defaultValue: false - name: timeout description: The amount of time (in seconds) that a request will wait for a client to establish a connection to a remote machine before a timeout occurs. - name: polling_timeout description: Timeout for polling. Default is 600 seconds. description: Gets the RTR extracted file contents for the specified file path. name: cs-falcon-rtr-retrieve-file outputs: - contextPath: CrowdStrike.File.FileName description: The filename. type: String - contextPath: CrowdStrike.File.HostID description: The host ID. type: String - contextPath: File.Size description: The size of the file. type: Number - contextPath: File.SHA1 description: The SHA1 hash of the file. type: String - contextPath: File.SHA256 description: The SHA256 hash of the file. type: String - contextPath: File.SHA512 description: The SHA512 hash of the file. type: String - contextPath: File.Name description: The name of the file. type: String - contextPath: File.SSDeep description: The SSDeep hash of the file. type: String - contextPath: File.EntryID description: The entry ID of the file. type: String - contextPath: File.Info description: Information about the file. type: String - contextPath: File.Type description: The file type. type: String - contextPath: File.MD5 description: The MD5 hash of the file. type: String - contextPath: File.Extension description: The extension of the file. type: String polling: true - arguments: [] description: Returns the list of fields to map in outgoing mirroring. This command is only used for debugging purposes. Note that this command is supported in Cortex XSOAR only. name: get-mapping-fields - arguments: - description: The remote incident or detection ID. name: id required: true - defaultValue: '0' description: The UTC timestamp in seconds of the last update. The incident or detection is only updated if it was modified after the last update time. name: lastUpdate description: Gets remote data from a remote incident or detection. This method does not update the current incident or detection, and should be used for debugging purposes only. Note that this command is supported in Cortex XSOAR only. name: get-remote-data - arguments: - description: Date string representing the local time in UTC timestamp in seconds. The incident or detection is only returned if it was modified after the last update time. name: lastUpdate description: Gets the list of incidents and detections that were modified since the last update time. This method is used for debugging purposes. The get-modified-remote-data command is used as part of the Mirroring feature that was introduced in Cortex XSOAR version 6.1. Note that this command is supported in Cortex XSOAR only. name: get-modified-remote-data - arguments: [] description: Updates the remote incident or detection with local incident or detection changes. This method is only used for debugging purposes and will not update the current incident or detection. Note that this command is supported in Cortex XSOAR only. name: update-remote-system - arguments: - description: Limit the vulnerabilities returned to specific properties. Each value must be enclosed in single quotes and placed immediately after the colon with no space. For example, 'filter=status:'open'+cve.id:['CVE-2013-3900','CVE-2021-1675']'. name: filter - description: A comma-separated list of unique agent identifiers (AIDs) of a sensor. name: aid isArray: true - description: A comma-separated list of unique identifiers for a vulnerability as cataloged in the National Vulnerability Database (NVD). This filter supports multiple values and negation. name: cve_id isArray: true - description: "A comma-separated list of severities of the CVE. The possible values are: CRITICAL, HIGH, MEDIUM, LOW, UNKNOWN, or NONE." name: cve_severity isArray: true - description: A comma-separated list of names of a tag assigned to a host. Retrieve tags from Host Tags APIs. name: tags isArray: true - description: "Status of a vulnerability. This filter supports multiple values and negation. The possible values are: open, closed, reopen, expired." name: status isArray: true - description: "Operating system platform. This filter supports negation. The possible values are: Windows, Mac, Linux." name: platform_name - description: A comma-separated list of unique system-assigned IDs of a host group. Retrieve the host group ID from Host Group APIs. name: host_group isArray: true - description: A comma-separated list of types of hosts a sensor is running on. name: host_type isArray: true - description: Filter for vulnerabilities based on the number of days since a host last connected to CrowdStrike Falcon. Enter a numeric value from 3 to 45 to indicate the number of days to look back. For example, last_seen_within:10. name: last_seen_within - auto: PREDEFINED description: Indicates if the vulnerability is suppressed by a suppression rule. name: is_suppressed isArray: false predefined: - 'true' - 'false' - auto: PREDEFINED description: Display remediation information type of data to be returned for each vulnerability entity. defaultValue: 'True' name: display_remediation_info predefined: - 'True' - 'False' - auto: PREDEFINED description: Whether to return logic information type of data for each vulnerability entity. defaultValue: 'True' name: display_evaluation_logic_info predefined: - 'True' - 'False' - auto: PREDEFINED description: Whether to return host information type of data for each vulnerability entity. name: display_host_info defaultValue: 'False' predefined: - 'True' - 'False' - description: The maximum number of items to return (1-2500). Use `next_token` to retrieve additional pages. defaultValue: '50' type: String name: limit - description: "Pagination cursor from a previous run's `CrowdStrike.VulnerabilityNextToken` output. Provide this value to fetch the next page of vulnerabilities. Expires in 120 seconds." name: next_token description: Retrieve vulnerability details according to the selected filter. Each request requires at least one filter parameter. Supported with the CrowdStrike Spotlight license. name: cs-falcon-spotlight-search-vulnerability outputs: - contextPath: CrowdStrike.Vulnerability.id description: Unique system-assigned ID of the vulnerability. type: String - contextPath: CrowdStrike.Vulnerability.cid description: Unique system-generated customer identifier (CID) of the account. type: String - contextPath: CrowdStrike.Vulnerability.aid description: Unique agent identifier (AID) of the sensor where the vulnerability was found. type: String - contextPath: CrowdStrike.Vulnerability.created_timestamp description: UTC date and time of when the vulnerability was created in Spotlight. type: Date - contextPath: CrowdStrike.Vulnerability.updated_timestamp description: UTC date and time of the last update made on the vulnerability. type: Date - contextPath: CrowdStrike.Vulnerability.status description: "Vulnerability's current status. Possible values are: open, closed, reopen, or expired." type: String - contextPath: CrowdStrike.Vulnerability.apps.product_name_version description: Name and version of the product associated with the vulnerability. type: String - contextPath: CrowdStrike.Vulnerability.apps.sub_status description: "Status of each product associated with the vulnerability. Possible values are: open, closed, or reopen." type: String - contextPath: CrowdStrike.Vulnerability.apps.remediation.ids description: Remediation ID of each product associated with the vulnerability. type: String - contextPath: CrowdStrike.Vulnerability.host_info.hostname description: Name of the machine. type: String - contextPath: CrowdStrike.Vulnerability.host_info.instance_id description: Cloud instance ID of the host. type: String - contextPath: CrowdStrike.Vulnerability.host_info.service_provider_account_id description: Cloud service provider account ID for the host. type: String - contextPath: CrowdStrike.Vulnerability.host_info.service_provider description: Cloud service provider for the host. type: String - contextPath: CrowdStrike.Vulnerability.host_info.os_build description: Operating system build. type: String - contextPath: CrowdStrike.Vulnerability.host_info.product_type_desc description: Type of host a sensor is running on. type: String - contextPath: CrowdStrike.Vulnerability.host_info.local_ip description: Device's local IP address. type: String - contextPath: CrowdStrike.Vulnerability.host_info.machine_domain description: Active directory domain name. type: String - contextPath: CrowdStrike.Vulnerability.host_info.os_version description: Operating system version. type: String - contextPath: CrowdStrike.Vulnerability.host_info.ou description: Active directory organizational unit name. type: String - contextPath: CrowdStrike.Vulnerability.host_info.site_name description: Active directory site name. type: String - contextPath: CrowdStrike.Vulnerability.host_info.system_manufacturer description: Name of the system manufacturer. type: String - contextPath: CrowdStrike.Vulnerability.host_info.groups.id description: Array of host group IDs that the host is assigned to. type: String - contextPath: CrowdStrike.Vulnerability.host_info.groups.name description: Array of host group names that the host is assigned to. type: String - contextPath: CrowdStrike.Vulnerability.host_info.tags description: Name of a tag assigned to a host. type: String - contextPath: CrowdStrike.Vulnerability.host_info.platform description: Operating system platform. This filter supports negation. type: String - contextPath: CrowdStrike.Vulnerability.remediation.entities.id description: Unique ID of the remediation. type: String - contextPath: CrowdStrike.Vulnerability.remediation.entities.reference description: Relevant reference for the remediation that can be used to get additional details for the remediation. type: String - contextPath: CrowdStrike.Vulnerability.remediation.entities.title description: Short description of the remediation. type: String - contextPath: CrowdStrike.Vulnerability.remediation.entities.action description: Expanded description of the remediation. type: String - contextPath: CrowdStrike.Vulnerability.remediation.entities.link description: Link to the remediation page for the vendor. In certain cases, this field is null. type: String - contextPath: CrowdStrike.Vulnerability.cve.id description: Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). type: String - contextPath: CrowdStrike.Vulnerability.cve.base_score description: Base score of the CVE (float value between 1 and 10). type: Number - contextPath: CrowdStrike.Vulnerability.cve.severity description: CVSS severity rating of the vulnerability. type: String - contextPath: CrowdStrike.Vulnerability.cve.exploit_status description: Numeric value of the most severe known exploit. type: Number - contextPath: CrowdStrike.Vulnerability.cve.exprt_rating description: ExPRT rating assigned by CrowdStrike's predictive AI rating system. type: String - contextPath: CrowdStrike.Vulnerability.cve.description description: Brief description of the CVE. type: String - contextPath: CrowdStrike.Vulnerability.cve.published_date description: UTC timestamp with the date and time of when the vendor published the CVE. type: Date - contextPath: CrowdStrike.Vulnerability.cve.vendor_advisory description: Link to the vendor page where the CVE was disclosed. type: String - contextPath: CrowdStrike.Vulnerability.cve.exploitability_score description: Exploitability score of the CVE (float values from 1-4). type: Number - contextPath: CrowdStrike.Vulnerability.cve.impact_score description: Impact score of the CVE (float values from 1-6). type: Number - contextPath: CrowdStrike.Vulnerability.cve.vector description: Textual representation of the metric values used to score the vulnerability. type: String - contextPath: CrowdStrike.Vulnerability.cve.remediation_level description: CVSS remediation level of the vulnerability (U = Unavailable, or O = Official fix). type: String - contextPath: CrowdStrike.Vulnerability.cve.cisa_info.is_cisa_kev description: Whether to filter for vulnerabilities that are in the CISA Known Exploited Vulnerabilities (KEV) catalog. type: Boolean - contextPath: CrowdStrike.Vulnerability.cve.cisa_info.due_date description: Date before which CISA mandates subject organizations to patch the vulnerability. type: Date - contextPath: CrowdStrike.Vulnerability.cve.spotlight_published_date description: UTC timestamp with the date and time Spotlight enabled coverage for the vulnerability. type: Date - contextPath: CrowdStrike.Vulnerability.cve.actors description: Adversaries associated with the vulnerability. type: String - contextPath: CrowdStrike.Vulnerability.cve.name description: The vulnerability name. type: String - contextPath: CrowdStrike.VulnerabilityNextToken description: "Pagination cursor returned by CrowdStrike when more results are available. Pass this value back as the `next_token` argument on the next invocation. Absent when no more pages exist. Expires in 120 seconds." type: String - arguments: - description: Deprecated. Use cve instead. name: cve_id isArray: true deprecated: true - description: Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). This filter supports multiple values and negation. name: cve isArray: true default: true description: Retrieve vulnerability details according to the selected filter. Each request requires at least one filter parameter. Supported with the CrowdStrike Spotlight license. name: cve outputs: - contextPath: DBotScore.Indicator description: The indicator that was tested. type: String - contextPath: DBotScore.Type description: The indicator type. type: String - contextPath: DBotScore.Vendor description: The vendor used to calculate the score. type: String - contextPath: DBotScore.Score description: The actual score. type: Number - arguments: - description: Maximum number of items to return (1-5000). defaultValue: '50' name: limit - description: Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). This filter supports multiple values and negation. name: cve_ids isArray: true required: true description: Retrieve vulnerability details for a specific ID and host. Supported with the CrowdStrike Spotlight license. name: cs-falcon-spotlight-list-host-by-vulnerability outputs: - contextPath: CrowdStrike.VulnerabilityHost.id description: Unique system-assigned ID of the vulnerability. type: String - contextPath: CrowdStrike.VulnerabilityHost.cid description: Unique system-generated customer identifier (CID) of the account. type: String - contextPath: CrowdStrike.VulnerabilityHost.aid description: Unique agent identifier (AID) of the sensor where the vulnerability was found. type: String - contextPath: CrowdStrike.VulnerabilityHost.created_timestamp description: UTC date and time of when the vulnerability was created in Spotlight. type: Date - contextPath: CrowdStrike.VulnerabilityHost.updated_timestamp description: UTC date and time of the last update made on the vulnerability. type: Date - contextPath: CrowdStrike.VulnerabilityHost.status description: "Vulnerability's current status. Possible values are: open, closed, reopen, or expired." type: String - contextPath: CrowdStrike.VulnerabilityHost.apps.product_name_version description: Name and version of the product associated with the vulnerability. type: String - contextPath: CrowdStrike.VulnerabilityHost.apps.sub_status description: "Status of each product associated with the vulnerability. Possible values are: open, closed, or reopen." type: String - contextPath: CrowdStrike.VulnerabilityHost.apps.remediation.ids description: Remediation ID of each product associated with the vulnerability. type: String - contextPath: CrowdStrike.VulnerabilityHost.apps.evaluation_logic.id description: Unique system-assigned ID of the vulnerability evaluation logic. type: String - contextPath: CrowdStrike.VulnerabilityHost.suppression_info.is_suppressed description: Indicates if the vulnerability is suppressed by a suppression rule. type: Boolean - contextPath: CrowdStrike.VulnerabilityHost.host_info.hostname description: Name of the machine. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.local_ip description: Device's local IP address. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.machine_domain description: Active directory domain name. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.os_version description: Operating system version. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.ou description: Active directory organizational unit name. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.site_name description: Active directory site name. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.system_manufacturer description: Name of the system manufacturer. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.platform description: Operating system platform. This filter supports negation. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.instance_id description: Cloud instance ID of the host. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.service_provider_account_id description: Cloud service provider account ID for the host. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.service_provider description: Cloud service provider for the host. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.os_build description: Operating system build. type: String - contextPath: CrowdStrike.VulnerabilityHost.host_info.product_type_desc description: Type of host a sensor is running on. type: String - contextPath: CrowdStrike.VulnerabilityHost.cve.id description: Unique identifier for a vulnerability as cataloged in the National Vulnerability Database (NVD). type: String - arguments: - description: Value to match for exclusion. name: value required: true - description: "A comma-separated list from where to exclude the exclusion. Possible values are: blocking, extraction." name: excluded_from required: true isArray: true - description: Comment describing why the exclusions were created. name: comment - description: A comma-separated list of group ID(s) impacted by the exclusion OR all if empty. name: groups isArray: true description: Create an ML exclusion. name: cs-falcon-create-ml-exclusion outputs: - contextPath: CrowdStrike.MLExclusion.id description: The ML exclusion ID. type: String - contextPath: CrowdStrike.MLExclusion.value description: The ML exclusion value. type: String - contextPath: CrowdStrike.MLExclusion.regexp_value description: A regular expression for matching the excluded value. type: String - contextPath: CrowdStrike.MLExclusion.value_hash description: An hash of the value field. type: String - contextPath: CrowdStrike.MLExclusion.excluded_from description: What the exclusion applies to (e.g., a specific ML model). type: String - contextPath: CrowdStrike.MLExclusion.groups.id description: Group ID that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.group_type description: Group type that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.name description: Group name that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.description description: Group description that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.assignment_rule description: Group assignment rule that the exclusion is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.created_by description: Indicate who created the group. type: String - contextPath: CrowdStrike.MLExclusion.groups.created_timestamp description: The date when the group was created. type: Date - contextPath: CrowdStrike.MLExclusion.groups.modified_by description: Indicate who last modified the group. type: String - contextPath: CrowdStrike.MLExclusion.groups.modified_timestamp description: The date when the group was last modified. type: Date - contextPath: CrowdStrike.MLExclusion.applied_globally description: Whether the exclusion rule applies globally or only to specific entities. type: Boolean - contextPath: CrowdStrike.MLExclusion.last_modified description: The date when the exclusion rule was last modified. type: Date - contextPath: CrowdStrike.MLExclusion.modified_by description: Indicate who last modified the rule. type: String - contextPath: CrowdStrike.MLExclusion.created_on description: The date when the exclusion rule was created. type: Date - contextPath: CrowdStrike.MLExclusion.created_by description: Indicate who created the rule. type: String - arguments: - description: The ID of the exclusion to update. name: id required: true - description: Value to match for the exclusion (the exclusion pattern). name: value - description: Comment describing why the exclusions were created. name: comment - description: A comma-separated list of group ID(s) impacted by the exclusion. name: groups isArray: true description: Updates an ML exclusion. At least one argument is required in addition to the id argument. name: cs-falcon-update-ml-exclusion outputs: - contextPath: CrowdStrike.MLExclusion.id description: The ML exclusion ID. type: String - contextPath: CrowdStrike.MLExclusion.value description: The ML exclusion value. type: String - contextPath: CrowdStrike.MLExclusion.regexp_value description: A regular expression for matching the excluded value. type: String - contextPath: CrowdStrike.MLExclusion.value_hash description: A hash of the value field. type: String - contextPath: CrowdStrike.MLExclusion.excluded_from description: What the exclusion applies to (e.g., a specific ML model). type: String - contextPath: CrowdStrike.MLExclusion.groups.id description: Group ID that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.group_type description: Group type that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.name description: Group name that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.description description: Group description that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.assignment_rule description: Group assignment rule that the exclusion is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.created_by description: Indicate who created the group. type: String - contextPath: CrowdStrike.MLExclusion.groups.created_timestamp description: The date when the group was created. type: Date - contextPath: CrowdStrike.MLExclusion.groups.modified_by description: Indicate who last modified the group. type: String - contextPath: CrowdStrike.MLExclusion.groups.modified_timestamp description: The date when the group was last modified. type: Date - contextPath: CrowdStrike.MLExclusion.applied_globally description: Whether the exclusion rule applies globally or only to specific entities. type: Boolean - contextPath: CrowdStrike.MLExclusion.last_modified description: The date when the exclusion rule was last modified. type: Date - contextPath: CrowdStrike.MLExclusion.modified_by description: Indicate who last modified the rule. type: String - contextPath: CrowdStrike.MLExclusion.created_on description: The date when the exclusion rule was created. type: Date - contextPath: CrowdStrike.MLExclusion.created_by description: Indicate who created the rule. type: String - arguments: - description: A comma-separated list of exclusion IDs to delete. name: ids required: true isArray: true description: Delete the ML exclusions by ID. name: cs-falcon-delete-ml-exclusion - arguments: - description: "A custom filter by which the exclusions should be filtered.\n The syntax follows the pattern `<property>:[operator]'<value>'`. For example: value:'test'.\n Available filters: applied_globally, created_by, created_on, last_modified, modified_by, value.\n For more information, see: https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql." name: filter - description: The value by which the exclusions should be filtered. name: value - description: A comma-separated list of exclusion IDs to retrieve. The IDs overwrite the filter and value. name: ids isArray: true - description: The maximum number of records to return. [1-500]. Applies only if the ids argument is not supplied. name: limit - description: The offset to start retrieving records from. Applies only if the ids argument is not supplied. name: offset - auto: PREDEFINED description: How to sort the retrieved exclusions. name: sort predefined: - applied_globally.asc - applied_globally.desc - created_by.asc - created_by.desc - created_on.asc - created_on.desc - last_modified.asc - last_modified.desc - modified_by.asc - modified_by.desc - value.asc - value.desc description: Get a list of ML exclusions by specifying their IDs, value, or a specific filter. name: cs-falcon-search-ml-exclusion outputs: - contextPath: CrowdStrike.MLExclusion.id description: The ML exclusion ID. type: String - contextPath: CrowdStrike.MLExclusion.value description: The ML exclusion value. type: String - contextPath: CrowdStrike.MLExclusion.regexp_value description: A regular expression for matching the excluded value. type: String - contextPath: CrowdStrike.MLExclusion.value_hash description: A hash of the value field. type: String - contextPath: CrowdStrike.MLExclusion.excluded_from description: What the exclusion applies to (e.g., a specific ML model). type: String - contextPath: CrowdStrike.MLExclusion.groups.id description: Group ID that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.group_type description: Group type that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.name description: Group name that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.description description: Group description that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.assignment_rule description: Group assignment rule that the exclusion is associated with. type: String - contextPath: CrowdStrike.MLExclusion.groups.created_by description: Indicate who created the group. type: String - contextPath: CrowdStrike.MLExclusion.groups.created_timestamp description: The date when the group was created. type: Date - contextPath: CrowdStrike.MLExclusion.groups.modified_by description: Indicate who last modified the group. type: String - contextPath: CrowdStrike.MLExclusion.groups.modified_timestamp description: The date when the group was last modified. type: Date - contextPath: CrowdStrike.MLExclusion.applied_globally description: Whether the exclusion rule applies globally or only to specific entities. type: Boolean - contextPath: CrowdStrike.MLExclusion.last_modified description: The date when the exclusion rule was last modified. type: Date - contextPath: CrowdStrike.MLExclusion.modified_by description: Indicate who last modified the rule. type: String - contextPath: CrowdStrike.MLExclusion.created_on description: The date when the exclusion rule was created. type: Date - contextPath: CrowdStrike.MLExclusion.created_by description: Indicate who created the rule. type: String - arguments: - description: Name of the exclusion. name: exclusion_name required: true - description: Name of the exclusion pattern. name: pattern_name - description: ID of the exclusion pattern. name: pattern_id required: true - description: Command line regular expression. name: cl_regex required: true - description: Image filename regular expression. name: ifn_regex required: true - description: Comment describing why the exclusions were created. name: comment - description: Exclusion description. name: description - description: JSON formatted detection template. name: detection_json - description: A comma-separated list of group ID(s) impacted by the exclusion OR all if empty. name: groups required: true isArray: true description: Create an IOA exclusion. name: cs-falcon-create-ioa-exclusion outputs: - contextPath: CrowdStrike.IOAExclusion.id description: A unique identifier for the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.name description: The name of the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.description description: A description of the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.pattern_id description: The identifier of the pattern associated with the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.pattern_name description: The name of the pattern associated with the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.ifn_regex description: A regular expression used for filename matching. type: String - contextPath: CrowdStrike.IOAExclusion.cl_regex description: A regular expression used for command line matching. type: String - contextPath: CrowdStrike.IOAExclusion.detection_json description: A JSON string that describes the detection logic for the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.groups.id description: Group ID that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.group_type description: Group type that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.name description: Group name that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.description description: Group description that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.assignment_rule description: Group assignment rule that the exclusion is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.created_by description: Indicate who created the group. type: String - contextPath: CrowdStrike.IOAExclusion.groups.created_timestamp description: The date when the group was created. type: Date - contextPath: CrowdStrike.IOAExclusion.groups.modified_by description: Indicate who last modified the group. type: String - contextPath: CrowdStrike.IOAExclusion.groups.modified_timestamp description: The date when the group was last modified. type: Date - contextPath: CrowdStrike.IOAExclusion.applied_globally description: Whether the exclusion rule applies globally or only to specific entities. type: Boolean - contextPath: CrowdStrike.IOAExclusion.last_modified description: The date when the exclusion rule was last modified. type: Date - contextPath: CrowdStrike.IOAExclusion.modified_by description: Indicate who last modified the rule. type: String - contextPath: CrowdStrike.IOAExclusion.created_on description: The date when the exclusion rule was created. type: Date - contextPath: CrowdStrike.IOAExclusion.created_by description: Indicate who created the rule. type: String - arguments: - description: ID of the exclusion to update. name: id required: true - description: Name of the exclusion. name: exclusion_name - description: ID of the exclusion pattern to update. name: pattern_id - description: Name of the exclusion pattern. name: pattern_name - description: Command line regular expression. name: cl_regex - description: Image filename regular expression. name: ifn_regex - description: Comment describing why the exclusions was created. name: comment - description: Exclusion description. name: description - description: JSON formatted detection template. name: detection_json - description: A comma-separated list of group ID(s) impacted by the exclusion. name: groups isArray: true description: Updates an IOA exclusion. At least one argument is required in addition to the id argument. name: cs-falcon-update-ioa-exclusion outputs: - contextPath: CrowdStrike.IOAExclusion.id description: A unique identifier for the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.name description: The name of the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.description description: A description of the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.pattern_id description: The identifier of the pattern associated with the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.pattern_name description: The name of the pattern associated with the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.ifn_regex description: A regular expression used for filename matching. type: String - contextPath: CrowdStrike.IOAExclusion.cl_regex description: A regular expression used for command line matching. type: String - contextPath: CrowdStrike.IOAExclusion.detection_json description: A JSON string that describes the detection logic for the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.groups.id description: Group ID that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.group_type description: Group type that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.name description: Group name that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.description description: Group description that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.assignment_rule description: Group assignment rule that the exclusion is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.created_by description: Indicate who created the group. type: String - contextPath: CrowdStrike.IOAExclusion.groups.created_timestamp description: The date when the group was created. type: Date - contextPath: CrowdStrike.IOAExclusion.groups.modified_by description: Indicate who last modified the group. type: String - contextPath: CrowdStrike.IOAExclusion.groups.modified_timestamp description: The date when the group was last modified. type: Date - contextPath: CrowdStrike.IOAExclusion.applied_globally description: Whether the exclusion rule applies globally or only to specific entities. type: Boolean - contextPath: CrowdStrike.IOAExclusion.last_modified description: The date when the exclusion rule was last modified. type: Date - contextPath: CrowdStrike.IOAExclusion.modified_by description: Indicate who last modified the rule. type: String - contextPath: CrowdStrike.IOAExclusion.created_on description: The date when the exclusion rule was created. type: Date - contextPath: CrowdStrike.IOAExclusion.created_by description: Indicate who created the rule. type: String - arguments: - description: A comma-separated list of exclusion IDs to delete. name: ids required: true isArray: true description: Delete the IOA exclusions by ID. name: cs-falcon-delete-ioa-exclusion - arguments: - description: "A custom filter by which the exclusions should be filtered.\n The syntax follows the pattern `<property>:[operator]'<value>'`. For example: name:'test'.\n Available filters: applied_globally, created_by, created_on, name, last_modified, modified_by, value, pattern.\n For more information, see: https://www.falconpy.io/Service-Collections/Falcon-Query-Language." name: filter - description: The name by which the exclusions should be filtered. name: name - description: A comma-separated list of exclusion IDs to retrieve. The IDs overwrite the filter and name. name: ids isArray: true - description: The limit of how many exclusions to retrieve. Default is 50. Applies only if the ids argument is not supplied. name: limit - description: The offset of how many exclusions to skip. Default is 0. Applies only if the ids argument is not supplied. name: offset description: Get a list of IOA exclusions by specifying their IDs or a filter. name: cs-falcon-search-ioa-exclusion outputs: - contextPath: CrowdStrike.IOAExclusion.id description: A unique identifier for the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.name description: The name of the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.description description: A description of the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.pattern_id description: The identifier of the pattern associated with the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.pattern_name description: The name of the pattern associated with the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.ifn_regex description: A regular expression used for filename matching. type: String - contextPath: CrowdStrike.IOAExclusion.cl_regex description: A regular expression used for command line matching. type: String - contextPath: CrowdStrike.IOAExclusion.detection_json description: A JSON string that describes the detection logic for the IOA exclusion. type: String - contextPath: CrowdStrike.IOAExclusion.groups.id description: Group ID that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.group_type description: Group type that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.name description: Group name that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.description description: Group description that the exclusion rule is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.assignment_rule description: Group assignment rule that the exclusion is associated with. type: String - contextPath: CrowdStrike.IOAExclusion.groups.created_by description: Indicate who created the group. type: String - contextPath: CrowdStrike.IOAExclusion.groups.created_timestamp description: The date when the group was created. type: Date - contextPath: CrowdStrike.IOAExclusion.groups.modified_by description: Indicate who last modified the group. type: String - contextPath: CrowdStrike.IOAExclusion.groups.modified_timestamp description: The date when the group was last modified. type: Date - contextPath: CrowdStrike.IOAExclusion.applied_globally description: Whether the exclusion rule applies globally or only to specific entities. type: Boolean - contextPath: CrowdStrike.IOAExclusion.last_modified description: The date when the exclusion rule was last modified. type: Date - contextPath: CrowdStrike.IOAExclusion.modified_by description: Indicate who last modified the rule. type: String - contextPath: CrowdStrike.IOAExclusion.created_on description: The date when the exclusion rule was created. type: Date - contextPath: CrowdStrike.IOAExclusion.created_by description: Indicate who created the rule. type: String - arguments: - description: A comma-separated list of quarantined file IDs to retrieve. name: ids isArray: true - description: A custom filter by which the retrieved quarantined file should be filtered. name: filter - description: A comma-separated list of SHA256 hash of the files to retrieve. name: sha256 isArray: true - description: A comma-separated list of the name of the files to retrieve. name: filename isArray: true - description: Filter the retrieved files by state. name: state - description: A comma-separated list of the hostnames of the files to retrieve. name: hostname isArray: true - description: A comma-separated list of the usernames of the files to retrieve. name: username isArray: true - description: Maximum number of IDs to return. Max 5000. Default 50. name: limit - description: Starting index of the overall result set from which to return IDs. Default 0. name: offset description: Get quarantine file metadata by specified IDs or filter. name: cs-falcon-list-quarantined-file outputs: - contextPath: CrowdStrike.QuarantinedFile.id description: A unique identifier for the quarantined file. type: String - contextPath: CrowdStrike.QuarantinedFile.aid description: The agent identifier of the agent that quarantined the file. type: String - contextPath: CrowdStrike.QuarantinedFile.cid description: The unique customer identifier of the agent that quarantined the file. type: String - contextPath: CrowdStrike.QuarantinedFile.sha256 description: The SHA256 hash value of the quarantined file. type: String - contextPath: CrowdStrike.QuarantinedFile.paths.path description: The full path of the quarantined file. type: String - contextPath: CrowdStrike.QuarantinedFile.paths.filename description: The name of the quarantined file. type: String - contextPath: CrowdStrike.QuarantinedFile.paths.state description: The current state of the quarantined file path (e.g., "purged"). type: String - contextPath: CrowdStrike.QuarantinedFile.state description: The current state of the quarantined file (e.g., "unrelease_pending"). type: String - contextPath: CrowdStrike.QuarantinedFile.detect_ids description: The detection identifiers associated with the quarantined file. type: String - contextPath: CrowdStrike.QuarantinedFile.hostname description: The hostname of the agent that quarantined the file. type: String - contextPath: CrowdStrike.QuarantinedFile.username description: The username associated with the quarantined file. type: String - contextPath: CrowdStrike.QuarantinedFile.date_updated description: The date the quarantined file was last updated. type: Date - contextPath: CrowdStrike.QuarantinedFile.date_created description: The date the quarantined file was created. type: Date - arguments: - description: A comma-separated list of quarantined file IDs to update. name: ids isArray: true - auto: PREDEFINED description: Action to perform against the quarantined file. name: action required: true predefined: - delete - release - unrelease - description: Comment to appear along with the action taken. name: comment required: true - description: Update files based on a custom filter. name: filter - description: A comma-separated list of quarantined SHA256 files to update. name: sha256 isArray: true - description: A comma-separated list of quarantined filenames to update. name: filename isArray: true - description: Update files based on the state. name: state - description: A comma-separated list of quarantined file hostnames to update. name: hostname isArray: true - description: A comma-separated list of quarantined file usernames to update. name: username isArray: true description: Apply action to quarantined files by file IDs or filter. name: cs-falcon-apply-quarantine-file-action - arguments: - description: Whether to poll for results. auto: PREDEFINED name: wait_for_result defaultValue: 'false' predefined: - 'true' - 'false' hidden: true - description: Valid CS-Falcon-FQL filter to query with. name: filter - description: Comma-separated list of scan IDs to retrieve details about. If set, will override all other arguments. isArray: true name: ids - description: Comma-separated list of scan initiation sources to filter by. isArray: true name: initiated_from - description: Comma-separated list of scan statuses to filter by. isArray: true name: status - description: Comma-separated list of scan severities to filter by. isArray: true name: severity - description: UTC-format of the scan start time to filter by. name: scan_started_on - description: UTC-format of the scan completion time to filter by. name: scan_completed_on - description: Starting index of overall result set from which to return IDs. name: offset - description: Maximum number of resources to return. name: limit - description: The interval in seconds between each poll. name: interval_in_seconds defaultValue: '30' hidden: true - description: The timeout in seconds until polling ends. name: timeout_in_seconds defaultValue: '600' hidden: true - name: hide_polling_output hidden: true description: Whether to hide the polling message and only print the final status at the end (automatically filled by polling. Can be used for testing purposes). defaultValue: true description: Retrieve ODS scan details. name: cs-falcon-ods-query-scan polling: true outputs: - contextPath: CrowdStrike.ODSScan.id description: A unique identifier for the scan event. type: String - contextPath: CrowdStrike.ODSScan.cid description: A unique identifier for the client that triggered the scan. type: String - contextPath: CrowdStrike.ODSScan.profile_id description: A unique identifier for the scan profile used in the scan. type: String - contextPath: CrowdStrike.ODSScan.description description: The ID of the description of the scan. type: String - contextPath: CrowdStrike.ODSScan.scan_inclusions description: The files or folders included in the scan. type: String - contextPath: CrowdStrike.ODSScan.initiated_from description: The source of the scan initiation. type: String - contextPath: CrowdStrike.ODSScan.quarantine description: Whether the scan was set to quarantine. type: Boolean - contextPath: CrowdStrike.ODSScan.cpu_priority description: The CPU priority for the scan (1-5). type: Number - contextPath: CrowdStrike.ODSScan.preemption_priority description: The preemption priority for the scan. type: Number - contextPath: CrowdStrike.ODSScan.metadata.host_id description: A unique identifier for the host that was scanned. type: String - contextPath: CrowdStrike.ODSScan.metadata.host_scan_id description: A unique identifier for the scan that was performed on the host. type: String - contextPath: CrowdStrike.ODSScan.metadata.scan_host_metadata_id description: A unique identifier for the metadata associated with the host scan. type: String - contextPath: CrowdStrike.ODSScan.metadata.filecount.scanned description: The number of files that were scanned. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.malicious description: The number of files that were identified as malicious. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.quarantined description: The number of files that were quarantined. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.skipped description: The number of files that were skipped during the scan. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.traversed description: The number of files that were traversed during the scan. type: Number - contextPath: CrowdStrike.ODSScan.metadata.status description: The status of the scan on this host. (e.g., "pending", "running", "completed", or "failed"). type: String - contextPath: CrowdStrike.ODSScan.metadata.started_on description: The date and time that the scan started. type: Date - contextPath: CrowdStrike.ODSScan.metadata.completed_on description: The date and time that the scan completed. type: Date - contextPath: CrowdStrike.ODSScan.metadata.last_updated description: The date and time that the metadata was last updated. type: Date - contextPath: CrowdStrike.ODSScan.status description: The status of the scan (e.g., "pending", "running", "completed", or "failed"). type: String - contextPath: CrowdStrike.ODSScan.hosts description: A list of the host IDs that were scanned. type: String - contextPath: CrowdStrike.ODSScan.endpoint_notification description: Indicates whether endpoint notifications are enabled. type: Boolean - contextPath: CrowdStrike.ODSScan.pause_duration description: The number of hours to pause between scanning each file. type: Number - contextPath: CrowdStrike.ODSScan.max_duration description: The maximum amount of time to allow for the scan job in hours. type: Number - contextPath: CrowdStrike.ODSScan.max_file_size description: The maximum file size (in MB) to scan. type: Number - contextPath: CrowdStrike.ODSScan.sensor_ml_level_detection description: The level of detection sensitivity for the local sensor machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.sensor_ml_level_prevention description: The level of prevention sensitivity for the local sensor machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.cloud_ml_level_detection description: The level of detection sensitivity for the cloud machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.cloud_ml_level_prevention description: The level of prevention sensitivity for the cloud machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.policy_setting description: A list of policy setting IDs for the scan job (these correspond to specific policy settings in the Falcon console). type: Number - contextPath: CrowdStrike.ODSScan.scan_started_on description: The timestamp when the scan was started. type: Date - contextPath: CrowdStrike.ODSScan.scan_completed_on description: The timestamp when the scan was completed. type: Date - contextPath: CrowdStrike.ODSScan.created_on description: The timestamp when the scan was created. type: Date - contextPath: CrowdStrike.ODSScan.created_by description: The ID of the user who created the scan job. type: String - contextPath: CrowdStrike.ODSScan.last_updated description: The timestamp when the scan job was last updated. type: Date - arguments: - description: Valid CS-Falcon-FQL filter to query with. name: filter - description: Comma-separated list of scan IDs to retrieve details about. If set, will override all other arguments. isArray: true name: ids - description: Comma-separated list of scan initiation sources to filter by. isArray: true name: initiated_from - description: Comma-separated list of scan statuses to filter by. isArray: true name: status - description: UTC-format of the scan creation time to filter by. name: created_on - description: UTC-format time of the scan creator to filter by. name: created_by - description: UTC-format of scan start time to filter by. name: start_timestamp - description: Deleted scans only. name: deleted - description: Starting index of overall result set from which to return IDs. name: offset - description: Maximum number of resources to return. name: limit description: Retrieve ODS scheduled scan details. name: cs-falcon-ods-query-scheduled-scan outputs: - contextPath: CrowdStrike.ODSScheduledScan.id description: Unique identifier for the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.cid description: Identifier for the customer or organization that owns the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.description description: The ID of the description of the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.file_paths description: The file or folder paths scanned. type: String - contextPath: CrowdStrike.ODSScheduledScan.scan_exclusions description: The file or folder exclusions from the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.initiated_from description: The source of the scan initiation. type: String - contextPath: CrowdStrike.ODSScheduledScan.cpu_priority description: The CPU priority for the scan (1-5). type: Number - contextPath: CrowdStrike.ODSScheduledScan.preemption_priority description: The preemption priority for the scan. type: Number - contextPath: CrowdStrike.ODSScheduledScan.status description: The status of the scan, whether it's "scheduled", "running", "completed", etc. type: String - contextPath: CrowdStrike.ODSScheduledScan.host_groups description: The host groups targeted by the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.endpoint_notification description: Whether notifications of the scan were sent to endpoints. type: Boolean - contextPath: CrowdStrike.ODSScheduledScan.pause_duration description: The pause duration of the scan in hours. type: Number - contextPath: CrowdStrike.ODSScheduledScan.max_duration description: The maximum duration of the scan in hours. type: Number - contextPath: CrowdStrike.ODSScheduledScan.max_file_size description: The maximum file size that the scan can handle in MB. type: Number - contextPath: CrowdStrike.ODSScheduledScan.sensor_ml_level_detection description: The machine learning detection level for the sensor. type: Number - contextPath: CrowdStrike.ODSScheduledScan.cloud_ml_level_detection description: The machine learning detection level for the cloud. type: Number - contextPath: CrowdStrike.ODSScheduledScan.schedule.start_timestamp description: The timestamp when the first scan was created. type: Date - contextPath: CrowdStrike.ODSScheduledScan.schedule.interval description: The interval between scans. type: Number - contextPath: CrowdStrike.ODSScheduledScan.created_on description: The timestamp when the scan was created. type: Date - contextPath: CrowdStrike.ODSScheduledScan.created_by description: The user who created the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.last_updated description: The timestamp when the scan was last updated. type: Date - contextPath: CrowdStrike.ODSScheduledScan.deleted description: Whether the scan was deleted. type: Boolean - contextPath: CrowdStrike.ODSScheduledScan.quarantine description: Whether the scan was set to quarantine. type: Boolean - contextPath: CrowdStrike.ODSScheduledScan.metadata.host_id description: Scan host IDs. type: String - contextPath: CrowdStrike.ODSScheduledScan.metadata.last_updated description: The date and time when the detection event was last updated. type: Date - contextPath: CrowdStrike.ODSScheduledScan.sensor_ml_level_prevention description: The machine learning prevention level for the sensor. type: Number - contextPath: CrowdStrike.ODSScheduledScan.cloud_ml_level_prevention description: The machine learning prevention level for the cloud. type: Number - arguments: - description: Valid CS-Falcon-FQL filter to query with. name: filter - description: Comma-separated list of host IDs to filter by. isArray: true name: host_ids - description: Comma-separated list of scan IDs to filter by. isArray: true name: scan_ids - description: Comma-separated list of scan statuses to filter by. isArray: true name: status - description: UTC-format of scan start time to filter by. name: started_on - description: UTC-format of scan completion time to filter by. name: completed_on - description: Starting index of the overall result set from which to return IDs. name: offset - description: Maximum number of resources to return. name: limit description: Retrieve ODS scan host details. name: cs-falcon-ods-query-scan-host outputs: - contextPath: CrowdStrike.ODSScanHost.id description: A unique identifier for the scan event. type: String - contextPath: CrowdStrike.ODSScanHost.cid description: A unique identifier for the client that triggered the scan. type: String - contextPath: CrowdStrike.ODSScanHost.scan_id description: A unique identifier for the scan. type: String - contextPath: CrowdStrike.ODSScanHost.profile_id description: A unique identifier for the scan profile used in the scan. type: String - contextPath: CrowdStrike.ODSScanHost.host_id description: A unique identifier for the host that was scanned. type: String - contextPath: CrowdStrike.ODSScanHost.host_scan_id description: A unique identifier for the scan that was performed on the host. type: String - contextPath: CrowdStrike.ODSScanHost.filecount.scanned description: The number of files that were scanned during the scan. type: Number - contextPath: CrowdStrike.ODSScanHost.filecount.malicious description: The number of files that were detected as malicious during the scan. type: Number - contextPath: CrowdStrike.ODSScanHost.filecount.quarantined description: The number of files that were quarantined during the scan. type: Number - contextPath: CrowdStrike.ODSScanHost.filecount.skipped description: The number of files that were skipped during the scan. type: Number - contextPath: CrowdStrike.ODSScanHost.status description: The status of the scan. (e.g., "completed", "pending", "cancelled", "running", or "failed"). type: String - contextPath: CrowdStrike.ODSScanHost.severity description: A severity score assigned to the scan, ranging from 0 to 100. type: Number - contextPath: CrowdStrike.ODSScanHost.started_on description: The date and time when the scan started. type: Date - contextPath: CrowdStrike.ODSScanHost.completed_on description: The date and time when the scan completed. type: Date - contextPath: CrowdStrike.ODSScanHost.last_updated description: The date and time when the scan event was last updated. type: Date - arguments: - description: Valid CS-Falcon-FQL filter to query with. name: filter - description: Comma-separated list of malicious file IDs to retrieve details about. If set, will override all other arguments. isArray: true name: file_ids - description: Comma-separated list of host IDs to filter by. isArray: true name: host_ids - description: Comma-separated list of scan IDs to filter by. isArray: true name: scan_ids - description: Comma-separated list of file paths to filter by. isArray: true name: file_paths - description: Comma-separated list of filenames to filter by. isArray: true name: file_names - description: Comma-separated list of hashes to filter by. isArray: true name: hash - description: Starting index of the overall result set from which to return IDs. name: offset - description: Maximum number of resources to return. name: limit description: Retrieve ODS malicious file details. name: cs-falcon-ods-query-malicious-files outputs: - contextPath: CrowdStrike.ODSMaliciousFile.id description: A unique identifier of the detection event. type: String - contextPath: CrowdStrike.ODSMaliciousFile.cid description: A unique identifier for the client that triggered the detection event. type: String - contextPath: CrowdStrike.ODSMaliciousFile.scan_id description: A unique identifier for the scan that triggered the detection event. type: String - contextPath: CrowdStrike.ODSMaliciousFile.host_id description: A unique identifier for the host that was scanned. type: String - contextPath: CrowdStrike.ODSMaliciousFile.host_scan_id description: A unique identifier for the scan that detected the file on the host. type: String - contextPath: CrowdStrike.ODSMaliciousFile.filepath description: The full path to the malicious file on the host system. type: String - contextPath: CrowdStrike.ODSMaliciousFile.filename description: The name of the malicious file. type: String - contextPath: CrowdStrike.ODSMaliciousFile.hash description: A SHA256 hash of the malicious file, which can be used to identify it. type: String - contextPath: CrowdStrike.ODSMaliciousFile.pattern_id description: The identifier of the pattern used to detect the malicious file. type: Number - contextPath: CrowdStrike.ODSMaliciousFile.severity description: A severity score assigned to the detection event, ranging from 0 to 100. type: Number - contextPath: CrowdStrike.ODSMaliciousFile.quarantined description: Indicates whether the file was quarantined. type: Boolean - contextPath: CrowdStrike.ODSMaliciousFile.last_updated description: The date and time when the detection event was last updated. type: Date - arguments: - description: A comma-separated list of hosts to be scanned. "hosts" OR "host_groups" must be set. isArray: true name: hosts - description: A comma-separated list of host groups to be scanned. "hosts" OR "host_groups" must be set. isArray: true name: host_groups - description: A comma-separated list of file paths to be scanned. "file_paths" OR "scan_inclusions" must be set. isArray: true name: file_paths - description: A comma-separated list of included files or locations for this scan. "file_paths" OR "scan_inclusions" must be set. isArray: true name: scan_inclusions - description: A comma-separated list of excluded files or locations for this scan. isArray: true name: scan_exclusions - description: Scan origin. name: initiated_from - description: The scan CPU priority. name: cpu_priority auto: PREDEFINED defaultValue: Low predefined: - Highest - High - Medium - Low - Lowest - description: Scan description. name: description - description: Flag indicating if identified threats should be quarantined. name: quarantine - description: Amount of time (in hours) for scan pauses. name: pause_duration defaultValue: '2' - description: Sensor ML detection level. name: sensor_ml_level_detection - description: Sensor ML prevention level. name: sensor_ml_level_prevention - description: Cloud ML detection level for the scan. name: cloud_ml_level_detection - description: Cloud ML prevention level for the scan. name: cloud_ml_level_prevention - description: Maximum time (in hours) the scan is allowed to execute. name: max_duration defaultValue: '2' - description: The interval in seconds between each poll. name: interval_in_seconds defaultValue: '30' - description: The timeout in seconds until polling ends. name: timeout_in_seconds defaultValue: '600' - name: cloud_pup_adware_level_detection required: false description: 'Potentially unwanted programs (PUPs) adware detection level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled).' auto: PREDEFINED predefined: - '0' - '1' - '2' - '3' - '4' - name: cloud_pup_adware_level_prevention required: false description: 'Potentially unwanted programs (PUPs) adware prevention level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled).' auto: PREDEFINED predefined: - '0' - '1' - '2' - '3' - '4' - name: polling description: Whether to use polling to wait for the scan result. If set to false, the command will only create the scan and return immediately without waiting for results. defaultValue: 'true' auto: PREDEFINED predefined: - 'true' - 'false' description: Create an ODS scan and wait for the results. name: cs-falcon-ods-create-scan polling: true outputs: - contextPath: CrowdStrike.ODSScan.id description: A unique identifier for the scan event. type: String - contextPath: CrowdStrike.ODSScan.cid description: A unique identifier for the client that triggered the scan. type: String - contextPath: CrowdStrike.ODSScan.profile_id description: A unique identifier for the scan profile used in the scan. type: String - contextPath: CrowdStrike.ODSScan.description description: The ID of the description of the scan. type: String - contextPath: CrowdStrike.ODSScan.scan_inclusions description: The files or folders included in the scan. type: String - contextPath: CrowdStrike.ODSScan.initiated_from description: The source of the scan initiation. type: String - contextPath: CrowdStrike.ODSScan.quarantine description: Whether the scan was set to quarantine. type: Boolean - contextPath: CrowdStrike.ODSScan.cpu_priority description: The CPU priority for the scan (1-5). type: Number - contextPath: CrowdStrike.ODSScan.preemption_priority description: The preemption priority for the scan. type: Number - contextPath: CrowdStrike.ODSScan.metadata.host_id description: A unique identifier for the host that was scanned. type: String - contextPath: CrowdStrike.ODSScan.metadata.host_scan_id description: A unique identifier for the scan that was performed on the host. type: String - contextPath: CrowdStrike.ODSScan.metadata.scan_host_metadata_id description: A unique identifier for the metadata associated with the host scan. type: String - contextPath: CrowdStrike.ODSScan.metadata.filecount.scanned description: The number of files that were scanned. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.malicious description: The number of files that were identified as malicious. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.quarantined description: The number of files that were quarantined. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.skipped description: The number of files that were skipped during the scan. type: Number - contextPath: CrowdStrike.ODSScan.metadata.filecount.traversed description: The number of files that were traversed during the scan. type: Number - contextPath: CrowdStrike.ODSScan.metadata.status description: The status of the scan on this host (e.g., "pending", "running", "completed", or "failed"). type: String - contextPath: CrowdStrike.ODSScan.metadata.started_on description: The date and time that the scan started. type: Date - contextPath: CrowdStrike.ODSScan.metadata.completed_on description: The date and time that the scan completed. type: Date - contextPath: CrowdStrike.ODSScan.metadata.last_updated description: The date and time that the metadata was last updated. type: Date - contextPath: CrowdStrike.ODSScan.status description: The status of the scan (e.g., "pending", "running", "completed", or "failed"). type: String - contextPath: CrowdStrike.ODSScan.hosts description: A list of the host IDs that were scanned. type: String - contextPath: CrowdStrike.ODSScan.endpoint_notification description: Indicates whether endpoint notifications are enabled. type: Boolean - contextPath: CrowdStrike.ODSScan.pause_duration description: The number of hours to pause between scanning each file. type: Number - contextPath: CrowdStrike.ODSScan.max_duration description: The maximum amount of time to allow for the scan job in hours. type: Number - contextPath: CrowdStrike.ODSScan.max_file_size description: The maximum file size (in MB) to scan. type: Number - contextPath: CrowdStrike.ODSScan.sensor_ml_level_detection description: The level of detection sensitivity for the local sensor machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.sensor_ml_level_prevention description: The level of prevention sensitivity for the local sensor machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.cloud_ml_level_detection description: The level of detection sensitivity for the cloud machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.cloud_ml_level_prevention description: The level of prevention sensitivity for the cloud machine learning model. type: Number - contextPath: CrowdStrike.ODSScan.policy_setting description: A list of policy setting IDs for the scan job (these correspond to specific policy settings in the Falcon console). type: Number - contextPath: CrowdStrike.ODSScan.scan_started_on description: The timestamp when the scan was started. type: Date - contextPath: CrowdStrike.ODSScan.scan_completed_on description: The timestamp when the scan was completed. type: Date - contextPath: CrowdStrike.ODSScan.created_on description: The timestamp when the scan was created. type: Date - contextPath: CrowdStrike.ODSScan.created_by description: The ID of the user who created the scan job. type: String - contextPath: CrowdStrike.ODSScan.last_updated description: The timestamp when the scan job was last updated. type: Date - contextPath: CrowdStrike.ODSScan.cloud_pup_adware_level_detection description: Potentially unwanted programs (PUPs) Adware detection level. type: Number - contextPath: CrowdStrike.ODSScan.cloud_pup_adware_level_prevention description: Potentially unwanted programs (PUPs) Adware prevention level. type: Number - arguments: - description: A comma-separated list of host groups to be scanned. isArray: true name: host_groups required: true - description: A comma-separated list of file paths to be scanned. "file_paths" OR "scan_inclusions" must be set. isArray: true name: file_paths - description: A comma-separated list of included files or locations for this scan. "file_paths" OR "scan_inclusions" must be set. isArray: true name: scan_inclusions - description: A comma-separated list of excluded files or locations for this scan. isArray: true name: scan_exclusions - description: Scan origin. name: initiated_from - description: The scan CPU priority. name: cpu_priority auto: PREDEFINED defaultValue: Low predefined: - Highest - High - Medium - Low - Lowest - description: Scan description. name: description - description: Flag indicating if identified threats should be quarantined. name: quarantine - description: Amount of time (in hours) for scan pauses. name: pause_duration defaultValue: '2' - description: Sensor ML detection level. name: sensor_ml_level_detection - description: Sensor ML prevention level. name: sensor_ml_level_prevention - description: Cloud ML detection level for the scan. name: cloud_ml_level_detection - description: Cloud ML prevention level for the scan. name: cloud_ml_level_prevention - description: Maximum time (in hours) the scan is allowed to execute. name: max_duration defaultValue: '2' - description: When to start the first scan. Supports english expressions such as "tomorrow" or "in an hour". name: schedule_start_timestamp required: true - description: The schedule interval. name: schedule_interval required: true auto: PREDEFINED predefined: - Never - Daily - Weekly - Every other week - Every four weeks - Monthly - name: cloud_pup_adware_level_detection required: false description: 'Potentially unwanted programs (PUPs) adware detection level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled).' auto: PREDEFINED predefined: - '0' - '1' - '2' - '3' - '4' - name: cloud_pup_adware_level_prevention required: false description: 'Potentially unwanted programs (PUPs) adware prevention level. Possible values are 0–4 (0 = Disabled). If not specified, CrowdStrike applies the default behavior (Disabled).' auto: PREDEFINED predefined: - '0' - '1' - '2' - '3' - '4' description: Create an ODS scheduled scan. name: cs-falcon-ods-create-scheduled-scan outputs: - contextPath: CrowdStrike.ODSScheduledScan.id description: Unique identifier for the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.cid description: Identifier for the customer or organization that owns the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.description description: The ID of the description of the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.file_paths description: The file or folder paths scanned. type: String - contextPath: CrowdStrike.ODSScheduledScan.scan_exclusions description: The file or folder exclusions from the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.initiated_from description: The source of the scan initiation. type: String - contextPath: CrowdStrike.ODSScheduledScan.cpu_priority description: The CPU priority for the scan (1-5). type: Number - contextPath: CrowdStrike.ODSScheduledScan.preemption_priority description: The preemption priority for the scan. type: Number - contextPath: CrowdStrike.ODSScheduledScan.status description: The status of the scan, whether it's "scheduled", "running", "completed", etc. type: String - contextPath: CrowdStrike.ODSScheduledScan.host_groups description: The host groups targeted by the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.endpoint_notification description: Whether notifications of the scan were sent to endpoints. type: Boolean - contextPath: CrowdStrike.ODSScheduledScan.pause_duration description: The pause duration of the scan in hours. type: Number - contextPath: CrowdStrike.ODSScheduledScan.max_duration description: The maximum duration of the scan in hours. type: Number - contextPath: CrowdStrike.ODSScheduledScan.max_file_size description: The maximum file size that the scan can handle in MB. type: Number - contextPath: CrowdStrike.ODSScheduledScan.sensor_ml_level_detection description: The machine learning detection level for the sensor. type: Number - contextPath: CrowdStrike.ODSScheduledScan.cloud_ml_level_detection description: The machine learning detection level for the cloud. type: Number - contextPath: CrowdStrike.ODSScheduledScan.schedule.start_timestamp description: The timestamp when the first scan was created. type: Date - contextPath: CrowdStrike.ODSScheduledScan.schedule.interval description: The interval between scans. type: Number - contextPath: CrowdStrike.ODSScheduledScan.created_on description: The timestamp when the scan was created. type: Date - contextPath: CrowdStrike.ODSScheduledScan.created_by description: The user who created the scan. type: String - contextPath: CrowdStrike.ODSScheduledScan.last_updated description: The timestamp when the scan was last updated. type: Date - contextPath: CrowdStrike.ODSScheduledScan.deleted description: Whether the scan was deleted. type: Boolean - contextPath: CrowdStrike.ODSScheduledScan.quarantine description: Whether the scan was set to quarantine. type: Boolean - contextPath: CrowdStrike.ODSScheduledScan.metadata.host_id description: Scan host IDs. type: String - contextPath: CrowdStrike.ODSScheduledScan.metadata.last_updated description: The date and time when the detection event was last updated. type: Date - contextPath: CrowdStrike.ODSScheduledScan.sensor_ml_level_prevention description: The machine learning prevention level for the sensor. type: Number - contextPath: CrowdStrike.ODSScheduledScan.cloud_ml_level_prevention description: The machine learning prevention level for the cloud. type: Number - contextPath: CrowdStrike.ODSScheduledScan.cloud_pup_adware_level_detection description: Potentially unwanted programs (PUPs) Adware detection level. type: Number - contextPath: CrowdStrike.ODSScheduledScan.cloud_pup_adware_level_prevention description: Potentially unwanted programs (PUPs) Adware prevention level. type: Number - arguments: - description: Comma-separated list of scheduled scan IDs to delete. isArray: true name: ids - description: Valid CS-Falcon-FQL filter to delete scans by. name: filter description: Delete ODS scheduled scans. name: cs-falcon-ods-delete-scheduled-scan outputs: [] - arguments: - description: API type. name: type required: true predefined: - 'USER' - 'ENDPOINT' auto: PREDEFINED - description: The key to sort by. name: sort_key predefined: - RISK_SCORE - PRIMARY_DISPLAY_NAME - SECONDARY_DISPLAY_NAME - MOST_RECENT_ACTIVITY - ENTITY_ID auto: PREDEFINED - description: The sort order. name: sort_order predefined: - 'DESCENDING' - 'ASCENDING' auto: PREDEFINED defaultValue: ASCENDING - description: A comma-separated list of entity IDs to look for. name: entity_id isArray: true - description: A comma-separated list of primary display names to filter by. name: primary_display_name isArray: true - description: A comma-separated list of secondary display names to filter by. name: secondary_display_name isArray: true - description: The maximum risk score severity to filter by. name: max_risk_score_severity predefined: - 'NORMAL' - 'MEDIUM' - 'HIGH' auto: PREDEFINED - description: The minimum risk score severity to filter by. name: min_risk_score_severity predefined: - 'NORMAL' - 'MEDIUM' - 'HIGH' auto: PREDEFINED - description: Whether to get only enabled or disabled identity entities. name: enabled predefined: - 'true' - 'false' auto: PREDEFINED - description: Email to filter by. name: email - description: The hash for the next page. name: next_token - description: The maximum number of items to fetch per page. The maximum value allowed is 1000. name: page_size defaultValue: 50 - description: The page number. Default is 1. name: page - description: The maximum number of identity entities to list. name: limit description: List identity entities. name: cs-falcon-list-identity-entities outputs: - contextPath: CrowdStrike.IDPEntity.Ishuman description: Whether the identity entity is human made. type: Boolean - contextPath: CrowdStrike.IDPEntity.Isprogrammatic description: Whether the identity entity is programmatic made. type: Boolean - contextPath: CrowdStrike.IDPEntity.Isadmin description: Whether the identity entity is admin made. type: String - contextPath: CrowdStrike.IDPEntity.Primarydisplayname description: The identity entity primary display name. type: String - contextPath: CrowdStrike.IDPEntity.Riskfactors.Type description: The identity entity risk factor type. type: Unknown - contextPath: CrowdStrike.IDPEntity.Riskfactors.Severity description: The identity entity risk factor severity. type: Unknown - contextPath: CrowdStrike.IDPEntity.Riskscore description: The identity entity risk score. type: Number - contextPath: CrowdStrike.IDPEntity.Riskscoreseverity description: The identity entity risk score severity. type: String - contextPath: CrowdStrike.IDPEntity.Secondarydisplayname description: The identity entity secondary display name. type: String - contextPath: CrowdStrike.IDPEntity.Emailaddresses description: The identity entity email address. type: String - arguments: - description: Comma-separated list of policy IDs to look for. name: policy_ids isArray: true required: true description: Given a CSV list of policy IDs, returns detailed policy information. name: cs-falcon-cspm-list-policy-details outputs: - contextPath: CrowdStrike.CSPMPolicy.ID description: The policy ID. type: Integer - contextPath: CrowdStrike.CSPMPolicy.CreatedAt description: The creation date. type: Date - contextPath: CrowdStrike.CSPMPolicy.UpdatedAt description: The update date. type: Date - contextPath: CrowdStrike.CSPMPolicy.DeletedAt description: The deletion date. type: Date - contextPath: CrowdStrike.CSPMPolicy.description description: The policy description. type: String - contextPath: CrowdStrike.CSPMPolicy.policy_statement description: The policy statement. type: String - contextPath: CrowdStrike.CSPMPolicy.policy_remediation description: The policy remediation. type: String - contextPath: CrowdStrike.CSPMPolicy.cloud_service_subtype description: The cloud service subtype. type: String - contextPath: CrowdStrike.CSPMPolicy.cloud_document description: The cloud document. type: String - contextPath: CrowdStrike.CSPMPolicy.mitre_attack_cloud_matrix description: URL to the MITRE attack tactics. type: String - contextPath: CrowdStrike.CSPMPolicy.mitre_attack_cloud_subtype description: URL to the MITRE attack techniques. type: String - contextPath: CrowdStrike.CSPMPolicy.alert_logic description: The alert logic. type: String - contextPath: CrowdStrike.CSPMPolicy.api_command description: The API command. type: String - contextPath: CrowdStrike.CSPMPolicy.cli_command description: The CLI command. type: String - contextPath: CrowdStrike.CSPMPolicy.cloud_platform_type description: The cloud platform type. type: String - contextPath: CrowdStrike.CSPMPolicy.cloud_service_type description: The cloud service type. type: String - contextPath: CrowdStrike.CSPMPolicy.default_severity description: The default severity. type: String - contextPath: CrowdStrike.CSPMPolicy.cis_benchmark_ids description: The CIS benchmark IDs. type: Array - contextPath: CrowdStrike.CSPMPolicy.nist_benchmark_ids description: The NIST benchmark IDs. type: Array - contextPath: CrowdStrike.CSPMPolicy.pci_benchmark_ids description: The PCI benchmark IDs. type: Array - contextPath: CrowdStrike.CSPMPolicy.policy_type description: The policy type. type: String - contextPath: CrowdStrike.CSPMPolicy.tactic_url description: The tactic URL. type: String - contextPath: CrowdStrike.CSPMPolicy.technique_url description: The technique URL. type: String - contextPath: CrowdStrike.CSPMPolicy.tactic description: The tactic used. type: String - contextPath: CrowdStrike.CSPMPolicy.technique description: The technique used. type: String - contextPath: CrowdStrike.CSPMPolicy.tactic_id description: The tactic ID. type: String - contextPath: CrowdStrike.CSPMPolicy.technique_id description: The technique ID. type: String - contextPath: CrowdStrike.CSPMPolicy.attack_types description: The attack types. type: Array - contextPath: CrowdStrike.CSPMPolicy.asset_type_id description: The asset type ID. type: Integer - contextPath: CrowdStrike.CSPMPolicy.cloud_asset_type description: The cloud asset type. type: String - contextPath: CrowdStrike.CSPMPolicy.is_remediable description: Whether the policy is remediable or not. type: Boolean - contextPath: CrowdStrike.CSPMPolicy.is_enabled description: Whether the policy is enabled or not. type: Boolean - contextPath: CrowdStrike.CSPMPolicy.account_scope description: The account scope. type: String - arguments: - description: The policy ID. name: policy_id - description: The cloud provider. name: cloud_platform defaultValue: 'aws' predefined: - 'aws' - 'gcp' - 'azure' auto: PREDEFINED - description: Service type to filter by. name: service - description: The maximum number of entities to list. name: limit defaultValue: 50 description: Returns information about current policy settings. name: cs-falcon-cspm-list-service-policy-settings outputs: - contextPath: CrowdStrike.CSPMPolicySetting.is_remediable description: Whether the policy setting is remediable or not. type: Boolean - contextPath: CrowdStrike.CSPMPolicySetting.created_at description: The creation date. type: String - contextPath: CrowdStrike.CSPMPolicySetting.updated_at description: The update date. type: String - contextPath: CrowdStrike.CSPMPolicySetting.policy_id description: The policy ID. type: Integer - contextPath: CrowdStrike.CSPMPolicySetting.name description: The policy setting name. type: String - contextPath: CrowdStrike.CSPMPolicySetting.policy_type description: The policy type. type: String - contextPath: CrowdStrike.CSPMPolicySetting.cloud_service_subtype description: The cloud service subtype. type: String - contextPath: CrowdStrike.CSPMPolicySetting.cloud_service description: The cloud service. type: String - contextPath: CrowdStrike.CSPMPolicySetting.cloud_service_friendly description: The cloud friendly service. type: String - contextPath: CrowdStrike.CSPMPolicySetting.cloud_asset_type description: The cloud asset type. type: String - contextPath: CrowdStrike.CSPMPolicySetting.cloud_asset_type_id description: The cloud asset type ID. type: Integer - contextPath: CrowdStrike.CSPMPolicySetting.cloud_provider description: The cloud provider. type: String - contextPath: CrowdStrike.CSPMPolicySetting.default_severity description: The default severity. type: String - contextPath: CrowdStrike.CSPMPolicySetting.policy_timestamp description: The policy timestamp. type: Date - contextPath: CrowdStrike.CSPMPolicySetting.policy_settings description: An array that holds policy settings. type: Array - contextPath: CrowdStrike.CSPMPolicySetting.policy_settings.account_id description: The account ID correlated to the policy. type: String - contextPath: CrowdStrike.CSPMPolicySetting.policy_settings.regions description: The regions in which the policy is configured. type: Array - contextPath: CrowdStrike.CSPMPolicySetting.policy_settings.severity description: The severity of the policy. type: String - contextPath: CrowdStrike.CSPMPolicySetting.policy_settings.enabled description: Whether the policy settings are enabled or not. type: Boolean - contextPath: CrowdStrike.CSPMPolicySetting.policy_settings.tag_excluded description: Whether the tag is excluded or not. type: Boolean - contextPath: CrowdStrike.CSPMPolicySetting.cis_benchmark description: An array of CIS benchmark details. type: Array - contextPath: CrowdStrike.CSPMPolicySetting.cis_benchmark.id description: The CIS benchmark ID. type: Integer - contextPath: CrowdStrike.CSPMPolicySetting.cis_benchmark.benchmark_short description: The CIS benchmark shortname. type: String - contextPath: CrowdStrike.CSPMPolicySetting.cis_benchmark.recommendation_number description: The CIS benchmark recommendation number. type: String - contextPath: CrowdStrike.CSPMPolicySetting.pci_benchmark description: An array of PCI benchmark details. type: Array - contextPath: CrowdStrike.CSPMPolicySetting.pci_benchmark.id description: The PCI benchmark ID. type: Integer - contextPath: CrowdStrike.CSPMPolicySetting.pci_benchmark.benchmark_short description: The PCI benchmark shortname. type: String - contextPath: CrowdStrike.CSPMPolicySetting.pci_benchmark.recommendation_number description: The PCI benchmark recommendation number. type: String - contextPath: CrowdStrike.CSPMPolicySetting.nist_benchmark description: An array of NIST benchmark details. type: Array - contextPath: CrowdStrike.CSPMPolicySetting.nist_benchmark.id description: The NIST benchmark ID. type: Integer - contextPath: CrowdStrike.CSPMPolicySetting.nist_benchmark.benchmark_short description: The NIST benchmark shortname. type: String - contextPath: CrowdStrike.CSPMPolicySetting.nist_benchmark.recommendation_number description: The NIST benchmark recommendation number. type: String - contextPath: CrowdStrike.CSPMPolicySetting.attack_types description: The attack types. type: Array - arguments: - description: Policy ID to be updated. name: policy_id required: true - description: Cloud account ID to impact. name: account_id - description: Flag indicating if this policy is enabled. name: enabled defaultValue: 'true' predefined: - 'false' - 'true' auto: PREDEFINED - description: A comma-separated list of regions where this policy is enforced. name: regions isArray: true - description: Policy severity value. name: severity predefined: - 'critical' - 'high' - 'medium' - 'informational' auto: PREDEFINED - description: Tag exclusion flag. name: tag_excluded predefined: - 'false' - 'true' auto: PREDEFINED description: Updates a policy setting. Can be used to override policy severity or to disable a policy entirely. name: cs-falcon-cspm-update-policy_settings - arguments: - description: A comma-separated list of IDs of the alerts to update. name: ids isArray: true required: true - description: Assign the specified detections to a user based on their username. name: assign_to_name - description: Assign the specified detections to a user based on their user ID (Email). name: assign_to_user_id - description: Assign the specified detections to a user based on their UUID. name: assign_to_uuid - description: Appends a new comment to any existing comments for the specified detections. name: append_comment - description: Add a tag to the specified detections. name: add_tag - description: Remove a tag from the specified detections. name: remove_tag - description: Update the status of the alert to the specified value. name: update_status predefined: - 'new' - 'in_progress' - 'closed' - 'reopened' auto: PREDEFINED - description: Whether to unassign any assigned users to the specified detections. name: unassign predefined: - 'false' - 'true' auto: PREDEFINED - description: If true, displays the detection in the UI. name: show_in_ui predefined: - 'false' - 'true' auto: PREDEFINED description: Perform actions on identity detection alerts. name: cs-falcon-resolve-identity-detection - arguments: - description: A comma-separated list of IDs of the alerts to update. name: ids isArray: true required: true - description: Assign the specified detections to a user based on their username. name: assign_to_name - description: Assign the specified detections to a user based on their user ID (Email). name: assign_to_user_id - description: Assign the specified detections to a user based on their UUID. name: assign_to_uuid - description: Appends a new comment to any existing comments for the specified detections. name: append_comment - description: Add a tag to the specified detections. name: add_tag - description: Remove a tag from the specified detections. name: remove_tag - description: Update the status of the alert to the specified value. name: update_status predefined: - 'new' - 'in_progress' - 'closed' - 'reopened' auto: PREDEFINED - description: Whether to unassign any assigned users to the specified detections. name: unassign predefined: - 'false' - 'true' auto: PREDEFINED - description: If true, displays the detection in the UI. name: show_in_ui predefined: - 'false' - 'true' auto: PREDEFINED description: Perform actions on mobile detection alerts. name: cs-falcon-resolve-mobile-detection - arguments: - description: A comma-separated list of IDs (UUIDs) of specific users to list. name: id isArray: true - description: 'The filter expression that should be used to limit the results. FQL syntax. Available values: assigned_cids, cid, first_name, last_name, name, uid. Example: "first_name:''John''".' name: filter - description: The integer offset to start retrieving records from. name: offset defaultValue: 0 - description: The maximum number of records to return. name: limit defaultValue: 50 description: List users. name: cs-falcon-list-users outputs: - contextPath: CrowdStrike.Users.uuid description: The user's UUID. type: String - contextPath: CrowdStrike.Users.cid description: The customer ID. type: String - contextPath: CrowdStrike.Users.uid description: The user's ID. type: String - contextPath: CrowdStrike.Users.first_name description: The user's first name. type: String - contextPath: CrowdStrike.Users.last_name description: The user's last name. type: String - contextPath: CrowdStrike.Users.last_login_at description: The timestamp of the user's last login. type: String - contextPath: CrowdStrike.Users.created_at description: The timestamp of the user's creation. type: String - arguments: - description: A comma-separated list of rule IDs to get IOA rules for. name: rule_ids isArray: true required: true description: Get IOA Rules. name: cs-falcon-get-ioarules outputs: - contextPath: CrowdStrike.IOARules.instance_id description: The IOA rule's instance ID. type: String - contextPath: CrowdStrike.IOARules.customer_id description: The customer ID. type: String - contextPath: CrowdStrike.IOARules.action_label description: The IOA rule's action label. type: String - contextPath: CrowdStrike.IOARules.comment description: The IOA rule's comment. type: String - contextPath: CrowdStrike.IOARules.committed_on description: The timestamp of the IOA rule's commitment. type: String - contextPath: CrowdStrike.IOARules.created_by description: The IOA rule's creator. type: String - contextPath: CrowdStrike.IOARules.created_on description: The timestamp of the IOA rule's creation. type: String - contextPath: CrowdStrike.IOARules.deleted description: Whether the IOA rule is in a deleted status. type: Boolean - contextPath: CrowdStrike.IOARules.description description: The IOA rule's description. type: String - contextPath: CrowdStrike.IOARules.disposition_id description: The disposition ID used by the IOA rule. type: String - contextPath: CrowdStrike.IOARules.enabled description: Whether the IOA rule is enabled. type: Boolean - contextPath: CrowdStrike.IOARules.field_values description: The IOA rule's field values. type: String - contextPath: CrowdStrike.IOARules.instance_version description: The IOA rule's instance version. type: String - contextPath: CrowdStrike.IOARules.magic_cookie description: The IOA rule's magic cookie. type: String - contextPath: CrowdStrike.IOARules.modified_by description: The last user who modified the IOA rule. type: String - contextPath: CrowdStrike.IOARules.modified_on description: The timestamp of the IOA rule's last modification. type: String - contextPath: CrowdStrike.IOARules.name description: The IOA rule name. type: String - contextPath: CrowdStrike.IOARules.pattern_id description: The IOA rule's pattern ID. type: String - contextPath: CrowdStrike.IOARules.pattern_severity description: The IOA rule's pattern severity. type: String - contextPath: CrowdStrike.IOARules.rulegroup_id description: The IOA rule's rule group ID. type: String - contextPath: CrowdStrike.IOARules.ruletype_id description: The IOA rule's rule type ID. type: String - contextPath: CrowdStrike.IOARules.ruletype_name description: The IOA rule's rule type name. type: String - contextPath: CrowdStrike.IOARules.version_ids description: The IOA rule's version ID. type: String - arguments: - description: The filter to use for the query. name: filter required: false description: Returns a list of CNAPP alerts. Used for debugging fetch-assets. name: cs-falcon-list-cnapp-alerts outputs: - contextPath: CrowdStrike.CnappAlert.containers_impacted_count description: The number of containers impacted by the alert. type: String - contextPath: CrowdStrike.CnappAlert.containers_impacted_ids description: The list of the ids of containers impacted by the alert. type: Array - contextPath: CrowdStrike.CnappAlert.detection_description description: The description of the alert. type: String - contextPath: CrowdStrike.CnappAlert.detection_event_simple_name description: The simple name of the alert. type: String - contextPath: CrowdStrike.CnappAlert.detection_name description: The name of the alert. type: String - contextPath: CrowdStrike.CnappAlert.first_seen_timestamp description: The first time the alert was seen. type: String - contextPath: CrowdStrike.CnappAlert.last_seen_timestamp description: The last time the alert was seen. type: String - contextPath: CrowdStrike.CnappAlert.severity description: The severity of the alert. type: String - arguments: - name: repository description: | The repository to run the query against. auto: PREDEFINED predefined: - search-all - third-party - falcon_for_it_view - forensics_view - investigate_view defaultValue: search-all - name: query description: 'The CQL query to use for the search. Note: Double quotes (“) and backslashes (\) in the queryString must be escaped with a backslash to ensure they are properly interpreted. Example: query="#event_simpleName = \"Event_name\""", For more details see: https://library.humio.com/data-analysis/syntax.html.' required: true - name: start description: | The start of the search window, based on the event timestamp. Note: 'end' must be later than 'start'. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., "1d", "2h", "30m", "1month"), ISO8601 timestamps (e.g., "2026-01-01T00:00:00Z"; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). - name: end description: | The end of the search window, based on the event timestamp. Note: 'end' must be later than 'start'. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., "1d", "2h", "30m", "1month"), ISO8601 timestamps (e.g., "2026-01-01T00:00:00Z"; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). - name: around_event_id description: The ID of the event to search around. Must be provided together with around_timestamp. - name: around_number_events_before description: Number of events to return before the target event. Requires around_event_id and around_timestamp. - name: around_number_events_after description: Number of events to return after the target event. Requires around_event_id and around_timestamp. - name: around_timestamp description: Timestamp for around search. Must be provided together with around_event_id. - name: ingest_start description: | The start of the search window, based on the event ingesttimestamp. Note: 'ingest_end' must be later than 'ingest_start'. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., "1d", "2h", "30m", "1month"), ISO8601 timestamps (e.g., "2026-01-01T00:00:00Z"; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). - name: ingest_end description: | The end of the search window, based on the event ingesttimestamp. Note: 'ingest_end' must be later than 'ingest_start'. If both start/end and ingest_start/ingest_end are provided, the server applies BOTH windows (AND). Supports relative durations (e.g., "1d", "2h", "30m", "1month"), ISO8601 timestamps (e.g., "2026-01-01T00:00:00Z"; if no time zone is provided, assumes UTC), and epoch timestamps (e.g., 1767225600000). - name: use_ingest_time description: When true, the server uses ingest_start/ingest_end as the query window. when false (or not set), it uses start/end. If both windows are provided, results are constrained by BOTH (AND). auto: PREDEFINED predefined: - 'true' - 'false' - name: limit description: Maximum number of events to return. Ignored when around_number_events_before or around_number_events_after parameters are specified. defaultValue: '50' - name: interval_in_seconds description: Interval between polling attempts in seconds. To prevent search timeouts, set this value within the 60–90 second range. defaultValue: '60' - name: timeout_in_seconds description: Timeout for polling in seconds. defaultValue: '600' - name: job_id description: Internal argument for polling - job ID from previous run. hidden: true - name: wait_for_result hidden: true description: Whether to poll for results. auto: PREDEFINED defaultValue: 'true' predefined: - 'true' - 'false' description: 'Search NGSIEM historical events. Requires NGSIEM scope with read and write permissions.' name: cs-falcon-search-ngsiem-events polling: true outputs: - contextPath: CrowdStrike.NGSiemEvent description: The list of all events returned from the search. type: Array - contextPath: CrowdStrike.NGSiemEvent.id description: The event ID. type: String - contextPath: CrowdStrike.NGSiemEvent.timestamp description: Event timestamp. type: String - arguments: - description: 'Filters results using a query in Falcon Query Language (FQL). For more information, see the FQL Syntax Documentation: https://www.falconpy.io/Usage/Falcon-Query-Language.html. For a list of available properties, see Workflow execution FQL filters - https://falcon.crowdstrike.com/documentation/page/z028de1a/fusion-workflow-apis#zec519e3' name: filter - description: The workflow definition ID to filter by. If 'filter' is provided, this argument is ignored. name: definition_id - description: The activity ID to filter by. If 'filter' is provided, this argument is ignored. name: activity_id - description: The workflow name to filter by. If 'filter' is provided, this argument is ignored. name: name - description: The workflow description to filter by. If 'filter' is provided, this argument is ignored. name: description - description: The offset to start retrieving records from. name: offset defaultValue: '0' - description: The maximum number of records to return. Max is 500. name: limit defaultValue: '50' - description: 'A comma-separated list of properties to sort by in the format property.direction (for example name.desc, time.asc, created_at.desc).' name: sort description: Lists workflow definitions from CrowdStrike Falcon. name: cs-falcon-list-workflow-definitions outputs: [] - arguments: - description: A comma-separated list of workflow definition IDs to execute. Either definition_id or name must be provided. name: definition_id isArray: true - description: The workflow name to execute. Either definition_id or name must be provided. name: name - description: A comma-separated list of CID(s) to execute the workflow on. name: execution_cid isArray: true - description: The key used for deduplication of workflow executions. If not set, a new UUID is used. name: key - description: The URL of the source that triggered the workflow execution. name: source_event_url - description: The JSON body to pass to the workflow execution. Can be an empty object {}. name: body description: 'Executes an on-demand workflow. Use cs-falcon-list-workflow-definitions to find workflows to run. Note: This command executes on-demand workflows only.' name: cs-falcon-workflow-execute outputs: [] - arguments: - description: 'Filters results using a query in Falcon Query Language (FQL). For more information, see the FQL Syntax Documentation: https://www.falconpy.io/Usage/Falcon-Query-Language.html. For a list of available properties, see Workflow execution FQL filters - https://falcon.crowdstrike.com/documentation/page/z028de1a/fusion-workflow-apis#zec519e3' name: filter - description: The workflow definition ID to filter by. If 'filter' is provided, this argument is ignored. name: definition_id - description: The workflow definition name to filter by. If 'filter' is provided, this argument is ignored. name: definition_name - description: The execution ID to filter by. If 'filter' is provided, this argument is ignored. name: execution_id - description: The offset to start retrieving records from. name: offset defaultValue: '0' - description: The maximum number of records to return. Max is 500. name: limit defaultValue: '50' - description: 'A comma-separated list of properties to sort by in the format property.direction (for example name.desc, time.asc, created_at.desc).' name: sort description: 'Lists workflow executions from CrowdStrike Falcon. Use cs-falcon-workflow-execute to find executions IDs.' name: cs-falcon-list-workflow-executions outputs: [] - arguments: - description: A comma-separated list of workflow execution IDs to retrieve results for. name: ids required: true isArray: true description: Gets detailed results for specific workflow executions. Use cs-falcon-list-workflow-executions to find execution IDs. name: cs-falcon-list-workflow-execution-results outputs: [] - arguments: - description: A comma-separated list of workflow execution IDs to perform the action on. Get the workflow execution ID using cs-falcon-list-workflow-executions. name: ids required: true isArray: true - auto: PREDEFINED description: The action to perform on the workflow executions. name: action_name required: true predefined: - cancel - resume description: Performs an action (cancel or resume) on one or more workflow executions. Use cs-falcon-list-workflow-execution-results to find execution activity status. name: cs-falcon-workflow-execution-action outputs: [] dockerimage: demisto/py3-tools:1.0.0.10120494 isfetch: true isfetch:marketplacev2: false isfetch:platform: true isfetchevents: true isfetchassets: true ismappable: true isremotesyncin: true isremotesyncout: true script: '-' subtype: python3 type: python fromversion: 5.0.0 tests: - Test - CrowdStrike Falcon - CrowdStrike Falcon Basic Test defaultclassifier: CrowdStrike Falcon defaultmapperin: CrowdStrike Falcon-Mapper defaultmapperout: CrowdStrike Falcon - Outgoing Mapper supportedModules: - agentix - xsiam - edr - cloud - cloud_runtime_security - exposure_management