Fortinet Document Library

Version:


Table of Contents

CrowdStrike Falcon

1.1.0
Copy Link

About the connector

The CrowdStrike Falcon® platform is pioneering cloud-delivered endpoint protection. It both delivers and unifies IT Hygiene, next-generation antivirus, endpoint detection and response (EDR), managed threat hunting, and threat intelligence — all delivered via a single lightweight agent.

This document provides information about the CrowdStrike Falcon connector, which facilitates automated interactions with CrowdStrike Falcon using FortiSOAR™ playbooks. Add the CrowdStrike Falcon connector as a step in FortiSOAR™ playbooks and perform automated investigative operations on endpoints and manage IOC for CrowdStrike Falcon, operations include creating an IOC on falcon and hunting a file or domain on CrowdStrike Falcon using a specified filehash or a specific domain.

Version information

Connector Version: 1.1.0

Authored By: Fortinet

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the CrowdStrike Falcon connector in version 1.1.0:

  • Added the following operations and playbooks:
    • Get Detection Details
    • Detection Search
    • Detection Aggregates
  • Added Record Count and Offset, as input parameters in the "Get Processes Related to IOC" and "Get IOCs" operations.
  • Added Query String, as an input parameters in the "Get Endpoint List" operation.

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-crowd-strike-falcon

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

  • You must have the URL of a CrowdStrike Falcon server to which you will connect and perform automated operations and the credentials (username and API Key pair) to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™ , on the Connectors page, click the CrowdStrike Falcon connector row, and in the Configure tab enter the required configuration details. 

Parameter Description
Server Address URL of the CrowdStrike Falcon server to which you will connect and perform the automated operations.
Username Username used to access the CrowdStrike Falcon server to which you will connect and perform the automated operations.
API Key API Key used to access the CrowdStrike Falcon server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function Description Annotation and Category
Create IOC Creates an indicator on CrowdStrike Falcon based on the IOC type and value, policy, and other input parameters you have specified. create_ioc
Investigation
Get IOCs Retrieves a list of all IOCs or specific IOCs based on the input parameters you have specified from CrowdStrike Falcon  get_iocs
Investigation
Get IOC Details Retrieves details of a specific IOC from CrowdStrike Falcon, based on the IOC type and value you have specified. get_ioc
Investigation
Update IOC Updates an indicator on CrowdStrike Falcon, based on the IOC type and value and other input parameters you have specified. update_ioc
Investigation
Delete IOC Deletes an indicator on CrowdStrike Falcon, based on the IOC type and value you have specified. delete_ioc
Remediation
Hunt File Hunts a file on CrowdStrike Falcon using the filehash type and value you have specified. hunt_file
Investigation
Hunt Domain Hunts a domain on CrowdStrike Falcon using the domain value you have specified. This operation retrieves a list of device IDs from CrowdStrike Falcon on which the domain was observed. hunt_domain
Investigation
Get Processes Related to IOC Retrieves a list of processes from CrowdStrike Falcon which are associated with the specified IOC on given device based on the IOC type and value, device ID, and other input parameters you have specified. get_processes
Investigation
Get Process Details Retrieves details of a specific process from CrowdStrike Falcon, based on the process ID you have specified. search_process
Investigation
Get Device Details Retrieves details of a specific device from CrowdStrike Falcon, based on the device ID you have specified. search_endpoint
Investigation
Get Endpoint List Retrieves a list of all the all endpoints or specific endpoints based on the input parameters you have specified configured on a device on CrowdStrike Falcon. get_endpoints
Investigation
Get Detection Details Retrieves details of a specific detection from CrowdStrike Falcon, based on the detection IDs you have specified. get_detection
Investigation
Detection Search Retrieves a list of all detection IDs or specific detection IDs based on the input parameters you have specified configured on a device on CrowdStrike Falcon. get_detection
Investigation
Detection Aggregates Retrieves a count of detections by a query from CrowdStrike Falcon based on the aggregate query name and type, the field used to compute the aggregation and other input parameters you have specified. detection_aggregates
Investigation
Set Detection State Sets the state of specific detections on CrowdStrike Falcon, based on the detection IDs you have specified. set_state
Investigation

operation: Create IOC

Input parameters

Parameter Description
IOC Type Type of indicator that you want to create on CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator that you want to create on CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.
Policy Policy that should be enacted when the IOC value is detected on a host.
Following is the list of policies:
  • detect: Sends a notification when the particular indicator has been detected on a host. 
  • none: Take no action when the particular indicator has been detected on a host. This is equivalent to turning the indicator off.
Indicator Share Level (Optional) Level the indicator will be shared.
Currently, only red share level (i.e., the indicator is not shared) is supported, which signifies that the IOC is not shared with other FH customers.
Time To Live (Optional) Days until when the indicator remains valid.
Note: This parameter only applies to Domain, IPv4, and IPv6 IOC types.
Indicator Source (Optional) Source of origination of the indicator that you want to create on CrowdStrike Falcon. This can be used for tracking where this indicator was defined.
Note: The indicator source is limited to 200 characters.
Indicator Description (Optional) Description of the indicator that you want to create on CrowdStrike Falcon.
Note: Description is limited to 200 characters.

Output

The output contains the following populated JSON schema:

     "result": "", 
     "status": "" 
}

operation: Get IOCs

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned.

Parameter Description
IOC Type List containing the types of indicators whose IOC list you want to retrieve from CrowdStrike Falcon. You can select multiple indicator types.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value List of indicator values based on the types that you have selected in the IOC Type field whose IOC list you want to retrieve from CrowdStrike Falcon.
Policy List of indicator policies whose associated IOCs you want to retrieve from CrowdStrike Falcon.
Indicator Share Level (Optional) Level the indicator will be shared.
Currently, only red share level (i.e., the indicator is not shared) is supported, which signifies that the IOC is not shared with other FH customers.
Indicator Source (Optional) List of IOC sources you want to retrieve from CrowdStrike Falcon.
Note: The indicator source is limited to 200 characters.
Earliest Expiration Date (Optional) RFC3339 DateTime that represents the starting date range to search for IOCs on CrowdStrike Falcon by their expiration timestamp.
Latest Expiration Date (Optional) RFC3339 DateTime that represents the ending date range to search for IOCs on CrowdStrike Falcon by their expiration timestamp.
Record Count (Optional) Number of items to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Offset (Optional) Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.
For example, if you specify 10 in this parameter, then the operation will start from the 10th record, then and return the list.

Output

The output contains the following populated JSON schema:

     "iocs_found": "" 
}

operation: Get IOC Details

Input parameters

Parameter Description
IOC Type Type of the indicator whose details you want to retrieve from CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator whose details you want to retrieve from CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.

Output

The output contains the following populated JSON schema:

     "ioc_details": { 
         "errors": [], 
         "meta": { 
             "query_time": "", 
             "trace_id": "" 
         }, 
         "resources": [ 
             { 
                 "source": "", 
                 "created_by": "", 
                 "share_level": "", 
                 "policy": "", 
                 "expiration_timestamp": "", 
                 "description": "", 
                 "modified_timestamp": "", 
                 "value": "", 
                 "created_timestamp": "", 
                 "modified_by": "", 
                 "type": "" 
             } 
         ] 
     } 
}

operation: Update IOC

Input parameters

Parameter Description
IOC Type Type of indicator that you want to update on CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator that you want to update on CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.
Policy (Optional) Policy that should be enacted when the IOC value is detected on a host.
Following is the list of policies:
  • detect: Sends a notification when the particular indicator has been detected on a host. 
  • none: Take no action when the particular indicator has been detected on a host. This is equivalent to turning the indicator off.
Indicator Share Level (Optional) Level the indicator will be shared.
Currently, only red share level (i.e., the indicator is not shared) is supported, which signifies that the IOC is not shared with other FH customers.
Time To Live (Optional) Days until when the indicator remains valid.
Note: This parameter only applies to Domain, IPv4, and IPv6 IOC types.
Indicator Source (Optional) Source of origination of the indicator that you want to update on CrowdStrike Falcon. This can be used for tracking where this indicator was defined.
Note: The indicator source is limited to 200 characters.
Indicator Description (Optional) Description of the indicator that you want to update on CrowdStrike Falcon.
Note: Description is limited to 200 characters.

Output

The output contains the following populated JSON schema:

     "result": "", 
     "status": "" 
}

operation: Delete IOC

Input parameters

Parameter Description
IOC Type Type of indicator that you want to delete from CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator that you want to delete from CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.

Output

The output contains the following populated JSON schema:

     "result": "", 
     "status": "" 
}

operation: Hunt File

Input parameters

Parameter Description
Filehash Type Type of the filehash that you want to hunt for on CrowdStrike Falcon. 
Filehash Value Value of the filehash that you want to hunt for on CrowdStrike Falcon.
Get Device Count Only If you select this parameter, i.e., set it to True, then the response will contain only the number of devices found for that Filehash and value on CrowdStrike Falcon. For example, "device_count": 13
If you clear this parameter, i.e., set it to False, then the response contains the list of device IDs found for that Filehash and value. For example, "resources": [ "1081290fbf104a1465cc0c91ca4ebe36", "739e412d9ff341a549a75e5c8107b0f3"])
By default, this parameter is cleared, i.e., set as False.

Output

The output contains the following populated JSON schema:

     "device_count": "" 
}

operation: Hunt Domain

Input parameters

Parameter Description
Domain Value of the domain that you want to hunt for on CrowdStrike Falcon.
Get Device Count Only If you select this parameter, i.e., set it to True, then the response will contain only the number of devices found for that domain on CrowdStrike Falcon.
If you clear this parameter, i.e., set it to False, then the response contains the list of device IDs found for that domain on CrowdStrike Falcon.
By default, this parameter is cleared, i.e., set as False.

Output

The output contains the following populated JSON schema:

     "device_count": "" 
}

operation: Get Processes Related to IOC

Input parameters

Parameter Description
IOC Type Type of indicator whose associated processes you want to retrieve from CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator whose associated processes you want to retrieve from CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.
Device ID ID of the device against which you want to check for IOCs and associated processes on CrowdStrike Falcon.
Record Count (Optional) Number of items to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Offset (Optional) Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.

Output

The output contains the following populated JSON schema:

     "process_ids": [], 
     "process_count": "" 
}

operation: Get Process Details

Input parameters

Parameter Description
Process ID ID of the process whose details you want to retrieve from CrowdStrike Falcon.
This parameter allows you to send multiple IDs to the endpoint to allow for more efficient multi-get type operations.

Output

The output contains the following populated JSON schema:

     "process_details": { 
         "meta": { 
             "query_time": "", 
             "trace_id": "" 
         }, 
         "errors": [], 
         "resources": [ 
             { 
                 "device_id": "", 
                 "stop_timestamp": "", 
                 "process_id_local": "", 
                 "file_name": "", 
                 "process_id": "", 
                 "start_timestamp_raw": "", 
                 "command_line": "", 
                 "start_timestamp": "", 
                 "stop_timestamp_raw": "" 
             } 
         ] 
     } 
}

operation: Get Device Details

Input parameters

Parameter Description
Device ID ID of the device whose details you want to retrieve from CrowdStrike Falcon.

Output

The output contains the following populated JSON schema:

     "system_info": { 
         "meta": { 
             "powered_by": "", 
             "trace_id": "", 
             "query_time": "" 
         }, 
         "errors": [], 
         "resources": [ 
             { 
                 "device_id": "", 
                 "config_id_build": "", 
                 "minor_version": "", 
                 "agent_load_flags": "", 
                 "first_seen": "", 
                 "major_version": "", 
                 "policies": [ 
                     { 
                         "assigned_date": "", 
                         "policy_type": "", 
                         "settings_hash": "", 
                         "policy_id": "", 
                         "applied": "", 
                         "applied_date": "" 
                     } 
                 ], 
                 "modified_timestamp": "", 
                 "system_manufacturer": "", 
                 "config_id_base": "", 
                 "cid": "", 
                 "agent_version": "", 
                 "mac_address": "", 
                 "bios_manufacturer": "", 
                 "machine_domain": "", 
                 "last_seen": "", 
                 "product_type_desc": "", 
                 "platform_name": "", 
                 "product_type": "", 
                 "agent_local_time": "", 
                 "platform_id": "", 
                 "device_policies": { 
                     "sensor_update": { 
                         "assigned_date": "", 
                         "policy_type": "", 
                         "settings_hash": "", 
                         "policy_id": "", 
                         "applied": "", 
                         "applied_date": "" 
                     }, 
                     "prevention": { 
                         "assigned_date": "", 
                         "policy_type": "", 
                         "settings_hash": "", 
                         "policy_id": "", 
                         "applied": "", 
                         "applied_date": "" 
                     } 
                 }, 
                 "system_product_name": "", 
                 "config_id_platform": "", 
                 "os_version": "", 
                 "bios_version": "", 
                 "external_ip": "", 
                 "site_name": "", 
                 "hostname": "", 
                 "local_ip": "", 
                 "status": "", 
                 "meta": { 
                     "version": "" 
                 } 
             } 
         ] 
     } 
}

operation: Get Endpoint List

Input parameters
Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned. 

Parameter Description
Query String Filter conditions based on which you want to filter the list of endpoints retrieved from CrowdStrike Falcon.
All parameters listed under Detection Search API > Parameters can be used as filters.
Offset Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.
Record Count Number of items to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.

Output

The output contains the following populated JSON schema:

     "list_of_endpoints": [], 
     "endpoint_count": "" 
}

operation: Get Detection Details

Input parameters

Parameter Description
Detection ID Comma-separated detection IDs or list of detection IDs whose details you want to retrieve from CrowdStrike Falcon.

Output

The output contains the following populated JSON schema:

     "errors": [], 
     "meta": { 
         "powered_by": "", 
         "query_time": "", 
         "trace_id": "" 
     }, 
     "resources": [] 
}

operation: Detection Search

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned. 

Parameter Description
Severity Name used in the UI to determine the severity of the detection that you want to search on CrowdStrike Falcon. You can select multiple options.
Valid values include: Critical, High, Medium, Low, and Informational.
Tactic Tactic for detection filtration on CrowdStrike Falcon.
Technique Technique for detection filtration on CrowdStrike Falcon.
Time Time, based on which you want to search for detections on CrowdStrike Falcon.
You can choose from the following values: Last Hour, Last Day, Last Week, Last 30 days, and Last 90 days. 
Status Current status of the detection that you want to search on CrowdStrike Falcon. You can select multiple options.
Valid values include: New, In Progress, True Positive, False Positive, and Ignored.
Detection ID ID of the detection that you want to search on CrowdStrike Falcon.
This ID can be used in conjunction with other APIs, such as the Detection Details API, or the Resolve Detection API.
Confidence When a detection has more than one associated behavior with varying confidence levels, this field captures the highest confidence value of all behaviors.
You can specify any integer between 1-100 in this parameter.
Sort By Sort detection records sort by any of the following values: Date Updated, Last Behaviour Descending, and Last Behaviour Ascending
Triggering File Name of the file that has triggered the process.
Assigned to Human-readable name of the user to whom the detection is currently assigned.
General Search Full-text search for detections across all metadata fields on CrowdStrike Falcon. 
Query String Filter conditions based on which you want to filter the list of detections retrieved from CrowdStrike Falcon.
All parameters listed under Detection Search API > Parameters can be used as filters.
Record Count Number of term buckets to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Offset (Optional) Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.

Output

The output contains the following populated JSON schema:

     "errors": [], 
     "meta": { 
         "pagination": { 
             "total": "", 
             "limit": "", 
             "offset": "" 
         }, 
         "powered_by": "", 
         "query_time": "", 
         "trace_id": "" 
     }, 
     "resources": [] 
}

operation: Detection Aggregates

Input parameters

Parameter Description
Name Name of the aggregate query, as specified by the user.
The name parameter is used to identify the results returned to you.
Aggregate Type Type of aggregation whose count you want to retrieve from CrowdStrike Falcon.
Valid values include: Date Histogram, Date Range, Terms, Cardinality, Max, and Min.
Field Field on which you want to compute the aggregation of detections.
All parameters listed under Detection Search API > Parameters can be used as fields for computing aggregations.
Time Interval Time interval for date histogram aggregations.
Valid values include: Year, Month, Week, Day, Hour, and Minute.
Query Filter String Filter conditions based on which you want to filter the list of detections retrieved from CrowdStrike Falcon.
All parameters listed under Detection Search API > Parameters can be used as filters.
General Search Full-text search for detections across all metadata fields on CrowdStrike Falcon.
Ranges Applies to range aggregations. Ranges values that you can specify will depend on the field that you have specified.
For example, if max_severity is used, ranges can look like [{"From": 0,"To": 70},{"From": 70,"To": 100}]
Date Ranges Applies to date_range aggregations.
For example, [{"from": "2016-05-28T09:00:31Z","to": "2016-05- 30T09:00:31Z"},{"from": "2016-06-01T09:00:31Z","to": "2016-06-10T09:00:31Z"}]
Missing Missing is the value to be used when the aggregation field is missing from the object/document. In other words, the missing parameter defines how documents that are missing the value should be treated.
By default, they will be ignored, but it is also possible to treat them as if they had a value.
Min Doc Count Only return term buckets if values are greater than or equal to the value that you have specified in this parameter.
Record Count Number of term buckets to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Sort By Sort detection aggregations based on the value specified in this parameter.
Sub Aggregates Nested aggregation. You can specify a maximum of 3 nested aggregations per request.
For example, "sub_aggregates" :[{"name": "max_first_behavior","type": "max","field": "first_behavior"}]"

Output

The output contains the following populated JSON schema:

     "errors": [], 
     "meta": { 
         "powered_by": "", 
         "query_time": "", 
         "trace_id": "" 
     }, 
     "resources": [] 
}

operation: Set Detection State

Input parameters

Parameter Description
Detection ID IDs of the detections whose state you want to set on CrowdStrike Falcon.:
Note: v2 of the CrowdStrike API, the CrowdStrike detection IDs are in the following format: ldt:[first field]:[second field] e.g. ldt:cf54bb61f92e4d3e75bf4f7c11fc8f74:4295536142 .
State Status to which you want to transition the specific detections.
Valid values include: New, In Progress, True Positive, False Positive, and Ignored.

Output

The output contains the following populated JSON schema:

     "result": { 
         "meta": { 
             "writes": { 
                 "resources_affected": "" 
             }, 
             "query_time": "", 
             "trace_id": "" 
         } 
     }, 
     "status": "" 
}

Included playbooks

The Sample - CrowdStrike Falcon - 1.1.0 playbook collection comes bundled with the CrowdStrike Falcon connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the CrowdStrike Falcon connector.

  • Create IOC
  • Delete IOC
  • Detection Aggregates
  • Detection Search
  • Get Detection Details
  • Get Device Details
  • Get Endpoint List
  • Get IOC Details
  • Get IOCs
  • Get Process Details
  • Get Processes Related to IOC
  • Hunt Domain
  • Hunt File
  • Set Detection State
  • Update IOC

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

About the connector

The CrowdStrike Falcon® platform is pioneering cloud-delivered endpoint protection. It both delivers and unifies IT Hygiene, next-generation antivirus, endpoint detection and response (EDR), managed threat hunting, and threat intelligence — all delivered via a single lightweight agent.

This document provides information about the CrowdStrike Falcon connector, which facilitates automated interactions with CrowdStrike Falcon using FortiSOAR™ playbooks. Add the CrowdStrike Falcon connector as a step in FortiSOAR™ playbooks and perform automated investigative operations on endpoints and manage IOC for CrowdStrike Falcon, operations include creating an IOC on falcon and hunting a file or domain on CrowdStrike Falcon using a specified filehash or a specific domain.

Version information

Connector Version: 1.1.0

Authored By: Fortinet

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the CrowdStrike Falcon connector in version 1.1.0:

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-crowd-strike-falcon

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™ , on the Connectors page, click the CrowdStrike Falcon connector row, and in the Configure tab enter the required configuration details. 

Parameter Description
Server Address URL of the CrowdStrike Falcon server to which you will connect and perform the automated operations.
Username Username used to access the CrowdStrike Falcon server to which you will connect and perform the automated operations.
API Key API Key used to access the CrowdStrike Falcon server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

Function Description Annotation and Category
Create IOC Creates an indicator on CrowdStrike Falcon based on the IOC type and value, policy, and other input parameters you have specified. create_ioc
Investigation
Get IOCs Retrieves a list of all IOCs or specific IOCs based on the input parameters you have specified from CrowdStrike Falcon  get_iocs
Investigation
Get IOC Details Retrieves details of a specific IOC from CrowdStrike Falcon, based on the IOC type and value you have specified. get_ioc
Investigation
Update IOC Updates an indicator on CrowdStrike Falcon, based on the IOC type and value and other input parameters you have specified. update_ioc
Investigation
Delete IOC Deletes an indicator on CrowdStrike Falcon, based on the IOC type and value you have specified. delete_ioc
Remediation
Hunt File Hunts a file on CrowdStrike Falcon using the filehash type and value you have specified. hunt_file
Investigation
Hunt Domain Hunts a domain on CrowdStrike Falcon using the domain value you have specified. This operation retrieves a list of device IDs from CrowdStrike Falcon on which the domain was observed. hunt_domain
Investigation
Get Processes Related to IOC Retrieves a list of processes from CrowdStrike Falcon which are associated with the specified IOC on given device based on the IOC type and value, device ID, and other input parameters you have specified. get_processes
Investigation
Get Process Details Retrieves details of a specific process from CrowdStrike Falcon, based on the process ID you have specified. search_process
Investigation
Get Device Details Retrieves details of a specific device from CrowdStrike Falcon, based on the device ID you have specified. search_endpoint
Investigation
Get Endpoint List Retrieves a list of all the all endpoints or specific endpoints based on the input parameters you have specified configured on a device on CrowdStrike Falcon. get_endpoints
Investigation
Get Detection Details Retrieves details of a specific detection from CrowdStrike Falcon, based on the detection IDs you have specified. get_detection
Investigation
Detection Search Retrieves a list of all detection IDs or specific detection IDs based on the input parameters you have specified configured on a device on CrowdStrike Falcon. get_detection
Investigation
Detection Aggregates Retrieves a count of detections by a query from CrowdStrike Falcon based on the aggregate query name and type, the field used to compute the aggregation and other input parameters you have specified. detection_aggregates
Investigation
Set Detection State Sets the state of specific detections on CrowdStrike Falcon, based on the detection IDs you have specified. set_state
Investigation

operation: Create IOC

Input parameters

Parameter Description
IOC Type Type of indicator that you want to create on CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator that you want to create on CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.
Policy Policy that should be enacted when the IOC value is detected on a host.
Following is the list of policies:
  • detect: Sends a notification when the particular indicator has been detected on a host. 
  • none: Take no action when the particular indicator has been detected on a host. This is equivalent to turning the indicator off.
Indicator Share Level (Optional) Level the indicator will be shared.
Currently, only red share level (i.e., the indicator is not shared) is supported, which signifies that the IOC is not shared with other FH customers.
Time To Live (Optional) Days until when the indicator remains valid.
Note: This parameter only applies to Domain, IPv4, and IPv6 IOC types.
Indicator Source (Optional) Source of origination of the indicator that you want to create on CrowdStrike Falcon. This can be used for tracking where this indicator was defined.
Note: The indicator source is limited to 200 characters.
Indicator Description (Optional) Description of the indicator that you want to create on CrowdStrike Falcon.
Note: Description is limited to 200 characters.

Output

The output contains the following populated JSON schema:

     "result": "", 
     "status": "" 
}

operation: Get IOCs

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned.

Parameter Description
IOC Type List containing the types of indicators whose IOC list you want to retrieve from CrowdStrike Falcon. You can select multiple indicator types.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value List of indicator values based on the types that you have selected in the IOC Type field whose IOC list you want to retrieve from CrowdStrike Falcon.
Policy List of indicator policies whose associated IOCs you want to retrieve from CrowdStrike Falcon.
Indicator Share Level (Optional) Level the indicator will be shared.
Currently, only red share level (i.e., the indicator is not shared) is supported, which signifies that the IOC is not shared with other FH customers.
Indicator Source (Optional) List of IOC sources you want to retrieve from CrowdStrike Falcon.
Note: The indicator source is limited to 200 characters.
Earliest Expiration Date (Optional) RFC3339 DateTime that represents the starting date range to search for IOCs on CrowdStrike Falcon by their expiration timestamp.
Latest Expiration Date (Optional) RFC3339 DateTime that represents the ending date range to search for IOCs on CrowdStrike Falcon by their expiration timestamp.
Record Count (Optional) Number of items to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Offset (Optional) Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.
For example, if you specify 10 in this parameter, then the operation will start from the 10th record, then and return the list.

Output

The output contains the following populated JSON schema:

     "iocs_found": "" 
}

operation: Get IOC Details

Input parameters

Parameter Description
IOC Type Type of the indicator whose details you want to retrieve from CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator whose details you want to retrieve from CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.

Output

The output contains the following populated JSON schema:

     "ioc_details": { 
         "errors": [], 
         "meta": { 
             "query_time": "", 
             "trace_id": "" 
         }, 
         "resources": [ 
             { 
                 "source": "", 
                 "created_by": "", 
                 "share_level": "", 
                 "policy": "", 
                 "expiration_timestamp": "", 
                 "description": "", 
                 "modified_timestamp": "", 
                 "value": "", 
                 "created_timestamp": "", 
                 "modified_by": "", 
                 "type": "" 
             } 
         ] 
     } 
}

operation: Update IOC

Input parameters

Parameter Description
IOC Type Type of indicator that you want to update on CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator that you want to update on CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.
Policy (Optional) Policy that should be enacted when the IOC value is detected on a host.
Following is the list of policies:
  • detect: Sends a notification when the particular indicator has been detected on a host. 
  • none: Take no action when the particular indicator has been detected on a host. This is equivalent to turning the indicator off.
Indicator Share Level (Optional) Level the indicator will be shared.
Currently, only red share level (i.e., the indicator is not shared) is supported, which signifies that the IOC is not shared with other FH customers.
Time To Live (Optional) Days until when the indicator remains valid.
Note: This parameter only applies to Domain, IPv4, and IPv6 IOC types.
Indicator Source (Optional) Source of origination of the indicator that you want to update on CrowdStrike Falcon. This can be used for tracking where this indicator was defined.
Note: The indicator source is limited to 200 characters.
Indicator Description (Optional) Description of the indicator that you want to update on CrowdStrike Falcon.
Note: Description is limited to 200 characters.

Output

The output contains the following populated JSON schema:

     "result": "", 
     "status": "" 
}

operation: Delete IOC

Input parameters

Parameter Description
IOC Type Type of indicator that you want to delete from CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator that you want to delete from CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.

Output

The output contains the following populated JSON schema:

     "result": "", 
     "status": "" 
}

operation: Hunt File

Input parameters

Parameter Description
Filehash Type Type of the filehash that you want to hunt for on CrowdStrike Falcon. 
Filehash Value Value of the filehash that you want to hunt for on CrowdStrike Falcon.
Get Device Count Only If you select this parameter, i.e., set it to True, then the response will contain only the number of devices found for that Filehash and value on CrowdStrike Falcon. For example, "device_count": 13
If you clear this parameter, i.e., set it to False, then the response contains the list of device IDs found for that Filehash and value. For example, "resources": [ "1081290fbf104a1465cc0c91ca4ebe36", "739e412d9ff341a549a75e5c8107b0f3"])
By default, this parameter is cleared, i.e., set as False.

Output

The output contains the following populated JSON schema:

     "device_count": "" 
}

operation: Hunt Domain

Input parameters

Parameter Description
Domain Value of the domain that you want to hunt for on CrowdStrike Falcon.
Get Device Count Only If you select this parameter, i.e., set it to True, then the response will contain only the number of devices found for that domain on CrowdStrike Falcon.
If you clear this parameter, i.e., set it to False, then the response contains the list of device IDs found for that domain on CrowdStrike Falcon.
By default, this parameter is cleared, i.e., set as False.

Output

The output contains the following populated JSON schema:

     "device_count": "" 
}

operation: Get Processes Related to IOC

Input parameters

Parameter Description
IOC Type Type of indicator whose associated processes you want to retrieve from CrowdStrike Falcon.
Valid types include: IPv4, IPv6, Domain, MD5, SHA1, and SHA256.
IOC Value String representation of the indicator whose associated processes you want to retrieve from CrowdStrike Falcon.
The value that you specify will be based on the IOC Type you have chosen.
Device ID ID of the device against which you want to check for IOCs and associated processes on CrowdStrike Falcon.
Record Count (Optional) Number of items to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Offset (Optional) Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.

Output

The output contains the following populated JSON schema:

     "process_ids": [], 
     "process_count": "" 
}

operation: Get Process Details

Input parameters

Parameter Description
Process ID ID of the process whose details you want to retrieve from CrowdStrike Falcon.
This parameter allows you to send multiple IDs to the endpoint to allow for more efficient multi-get type operations.

Output

The output contains the following populated JSON schema:

     "process_details": { 
         "meta": { 
             "query_time": "", 
             "trace_id": "" 
         }, 
         "errors": [], 
         "resources": [ 
             { 
                 "device_id": "", 
                 "stop_timestamp": "", 
                 "process_id_local": "", 
                 "file_name": "", 
                 "process_id": "", 
                 "start_timestamp_raw": "", 
                 "command_line": "", 
                 "start_timestamp": "", 
                 "stop_timestamp_raw": "" 
             } 
         ] 
     } 
}

operation: Get Device Details

Input parameters

Parameter Description
Device ID ID of the device whose details you want to retrieve from CrowdStrike Falcon.

Output

The output contains the following populated JSON schema:

     "system_info": { 
         "meta": { 
             "powered_by": "", 
             "trace_id": "", 
             "query_time": "" 
         }, 
         "errors": [], 
         "resources": [ 
             { 
                 "device_id": "", 
                 "config_id_build": "", 
                 "minor_version": "", 
                 "agent_load_flags": "", 
                 "first_seen": "", 
                 "major_version": "", 
                 "policies": [ 
                     { 
                         "assigned_date": "", 
                         "policy_type": "", 
                         "settings_hash": "", 
                         "policy_id": "", 
                         "applied": "", 
                         "applied_date": "" 
                     } 
                 ], 
                 "modified_timestamp": "", 
                 "system_manufacturer": "", 
                 "config_id_base": "", 
                 "cid": "", 
                 "agent_version": "", 
                 "mac_address": "", 
                 "bios_manufacturer": "", 
                 "machine_domain": "", 
                 "last_seen": "", 
                 "product_type_desc": "", 
                 "platform_name": "", 
                 "product_type": "", 
                 "agent_local_time": "", 
                 "platform_id": "", 
                 "device_policies": { 
                     "sensor_update": { 
                         "assigned_date": "", 
                         "policy_type": "", 
                         "settings_hash": "", 
                         "policy_id": "", 
                         "applied": "", 
                         "applied_date": "" 
                     }, 
                     "prevention": { 
                         "assigned_date": "", 
                         "policy_type": "", 
                         "settings_hash": "", 
                         "policy_id": "", 
                         "applied": "", 
                         "applied_date": "" 
                     } 
                 }, 
                 "system_product_name": "", 
                 "config_id_platform": "", 
                 "os_version": "", 
                 "bios_version": "", 
                 "external_ip": "", 
                 "site_name": "", 
                 "hostname": "", 
                 "local_ip": "", 
                 "status": "", 
                 "meta": { 
                     "version": "" 
                 } 
             } 
         ] 
     } 
}

operation: Get Endpoint List

Input parameters
Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned. 

Parameter Description
Query String Filter conditions based on which you want to filter the list of endpoints retrieved from CrowdStrike Falcon.
All parameters listed under Detection Search API > Parameters can be used as filters.
Offset Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.
Record Count Number of items to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.

Output

The output contains the following populated JSON schema:

     "list_of_endpoints": [], 
     "endpoint_count": "" 
}

operation: Get Detection Details

Input parameters

Parameter Description
Detection ID Comma-separated detection IDs or list of detection IDs whose details you want to retrieve from CrowdStrike Falcon.

Output

The output contains the following populated JSON schema:

     "errors": [], 
     "meta": { 
         "powered_by": "", 
         "query_time": "", 
         "trace_id": "" 
     }, 
     "resources": [] 
}

operation: Detection Search

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criterion is applied, and an unfiltered list is returned. 

Parameter Description
Severity Name used in the UI to determine the severity of the detection that you want to search on CrowdStrike Falcon. You can select multiple options.
Valid values include: Critical, High, Medium, Low, and Informational.
Tactic Tactic for detection filtration on CrowdStrike Falcon.
Technique Technique for detection filtration on CrowdStrike Falcon.
Time Time, based on which you want to search for detections on CrowdStrike Falcon.
You can choose from the following values: Last Hour, Last Day, Last Week, Last 30 days, and Last 90 days. 
Status Current status of the detection that you want to search on CrowdStrike Falcon. You can select multiple options.
Valid values include: New, In Progress, True Positive, False Positive, and Ignored.
Detection ID ID of the detection that you want to search on CrowdStrike Falcon.
This ID can be used in conjunction with other APIs, such as the Detection Details API, or the Resolve Detection API.
Confidence When a detection has more than one associated behavior with varying confidence levels, this field captures the highest confidence value of all behaviors.
You can specify any integer between 1-100 in this parameter.
Sort By Sort detection records sort by any of the following values: Date Updated, Last Behaviour Descending, and Last Behaviour Ascending
Triggering File Name of the file that has triggered the process.
Assigned to Human-readable name of the user to whom the detection is currently assigned.
General Search Full-text search for detections across all metadata fields on CrowdStrike Falcon. 
Query String Filter conditions based on which you want to filter the list of detections retrieved from CrowdStrike Falcon.
All parameters listed under Detection Search API > Parameters can be used as filters.
Record Count Number of term buckets to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Offset (Optional) Index of the first item that this operation should return.
This allows you to use a pagination token returned by the API to paginate a set of results and allows you to resume pagination without retrieving the already encountered items.

Output

The output contains the following populated JSON schema:

     "errors": [], 
     "meta": { 
         "pagination": { 
             "total": "", 
             "limit": "", 
             "offset": "" 
         }, 
         "powered_by": "", 
         "query_time": "", 
         "trace_id": "" 
     }, 
     "resources": [] 
}

operation: Detection Aggregates

Input parameters

Parameter Description
Name Name of the aggregate query, as specified by the user.
The name parameter is used to identify the results returned to you.
Aggregate Type Type of aggregation whose count you want to retrieve from CrowdStrike Falcon.
Valid values include: Date Histogram, Date Range, Terms, Cardinality, Max, and Min.
Field Field on which you want to compute the aggregation of detections.
All parameters listed under Detection Search API > Parameters can be used as fields for computing aggregations.
Time Interval Time interval for date histogram aggregations.
Valid values include: Year, Month, Week, Day, Hour, and Minute.
Query Filter String Filter conditions based on which you want to filter the list of detections retrieved from CrowdStrike Falcon.
All parameters listed under Detection Search API > Parameters can be used as filters.
General Search Full-text search for detections across all metadata fields on CrowdStrike Falcon.
Ranges Applies to range aggregations. Ranges values that you can specify will depend on the field that you have specified.
For example, if max_severity is used, ranges can look like [{"From": 0,"To": 70},{"From": 70,"To": 100}]
Date Ranges Applies to date_range aggregations.
For example, [{"from": "2016-05-28T09:00:31Z","to": "2016-05- 30T09:00:31Z"},{"from": "2016-06-01T09:00:31Z","to": "2016-06-10T09:00:31Z"}]
Missing Missing is the value to be used when the aggregation field is missing from the object/document. In other words, the missing parameter defines how documents that are missing the value should be treated.
By default, they will be ignored, but it is also possible to treat them as if they had a value.
Min Doc Count Only return term buckets if values are greater than or equal to the value that you have specified in this parameter.
Record Count Number of term buckets to be returned in a single request.
Note: You can specify the minimum number as 1 and the maximum number of 500.
Sort By Sort detection aggregations based on the value specified in this parameter.
Sub Aggregates Nested aggregation. You can specify a maximum of 3 nested aggregations per request.
For example, "sub_aggregates" :[{"name": "max_first_behavior","type": "max","field": "first_behavior"}]"

Output

The output contains the following populated JSON schema:

     "errors": [], 
     "meta": { 
         "powered_by": "", 
         "query_time": "", 
         "trace_id": "" 
     }, 
     "resources": [] 
}

operation: Set Detection State

Input parameters

Parameter Description
Detection ID IDs of the detections whose state you want to set on CrowdStrike Falcon.:
Note: v2 of the CrowdStrike API, the CrowdStrike detection IDs are in the following format: ldt:[first field]:[second field] e.g. ldt:cf54bb61f92e4d3e75bf4f7c11fc8f74:4295536142 .
State Status to which you want to transition the specific detections.
Valid values include: New, In Progress, True Positive, False Positive, and Ignored.

Output

The output contains the following populated JSON schema:

     "result": { 
         "meta": { 
             "writes": { 
                 "resources_affected": "" 
             }, 
             "query_time": "", 
             "trace_id": "" 
         } 
     }, 
     "status": "" 
}

Included playbooks

The Sample - CrowdStrike Falcon - 1.1.0 playbook collection comes bundled with the CrowdStrike Falcon connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the CrowdStrike Falcon connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.