Skip to main content

CrowdStrike Threat Intelligence Integration Guide

Overview

The CrowdStrike Threat Intelligence integration allows your NINA workflows to connect with CrowdStrike Falcon platform for threat intelligence, iocs, and threat analysis capabilities. This integration enables automated security operations, threat detection, and incident response directly from your automation platform.

Capabilities

This integration provides access to 7 resources with 79 operations covering:

  • Ioc: Operations for Ioc
  • Intel: Operations for Intel
  • Intelligence Feeds: Operations for Intelligence Feeds
  • Intelligence Indicator Graph: Operations for Intelligence Indicator Graph
  • Iocs: Operations for Iocs
  • Recon: Operations for Recon
  • Tailored Intelligence: Operations for Tailored Intelligence

Credential Configuration

Before using the CrowdStrike Threat Intelligence integration in your workflows, you need to configure credentials for authentication.

Authentication Method

CrowdStrike Falcon uses OAuth2 Client Credentials authentication. This is a server-to-server authentication flow where you provide a Client ID and Client Secret, and the integration automatically handles token acquisition and refresh.

FieldDescriptionRequired
Client IDYour CrowdStrike API Client IDYes
Client SecretYour CrowdStrike API Client SecretYes
Base URLCrowdStrike API endpoint for your cloud regionYes

How It Works

  1. You provide the Client ID and Client Secret when creating a credential
  2. The integration exchanges these for an OAuth2 access token automatically
  3. Tokens are refreshed automatically when they expire
  4. No redirect URLs or user interaction required

CrowdStrike Cloud Regions

Select the Base URL that matches your CrowdStrike Falcon cloud region:

Cloud RegionBase URLDescription
US-1https://api.crowdstrike.comUnited States (default)
US-2https://api.us-2.crowdstrike.comUnited States (secondary)
EU-1https://api.eu-1.crowdstrike.comEuropean Union
US-GOV-1https://api.laggar.gcw.crowdstrike.comUS Government Cloud

How to Obtain API Credentials

  1. Log in to the CrowdStrike Falcon Console
  2. Navigate to Support and resources > API Clients and Keys
  3. Click Add new API client
  4. Configure the API client:
    • Client Name: A descriptive name (e.g., "NINA Integration")
    • Description: Purpose of this API client
    • API Scopes: Select the permissions required for your use case (see Required Scopes below)
  5. Click Add to create the client
  6. Copy and securely store the Client ID and Client Secret immediately

Important: The Client Secret is only displayed once at creation time. If you lose it, you must create a new API client.

Required API Scopes

The API scopes required depend on which operations you plan to use. Common scopes include:

ScopePermissionUse Case
DetectionsRead/WriteView and manage detections
HostsRead/WriteQuery and manage endpoints
IncidentsRead/WriteView and manage incidents
IOCsRead/WriteManage indicators of compromise
Prevention PoliciesRead/WriteManage prevention policies
Real Time ResponseRead/WriteExecute RTR commands
Sensor Update PoliciesRead/WriteManage sensor updates

Refer to the CrowdStrike API documentation for a complete list of available scopes.

Creating a CrowdStrike Credential in NINA

  1. Navigate to the Credentials section in NINA
  2. Click Add New Credential
  3. Fill in the credential details:
    • Integration Service: Select "CrowdStrike Threat Intelligence"
    • Client ID: Paste your CrowdStrike API Client ID
    • Client Secret: Paste your CrowdStrike API Client Secret
    • Base URL: Select your CrowdStrike cloud region URL
  4. Click Test Connection to verify the credentials work
  5. Click Save to store the credential securely

Note: All CrowdStrike integrations (EDR, Intel, Platform, etc.) share the same credential. You only need to create one credential to use across all CrowdStrike modules.

Supported Resources

ResourceDescriptionOperations
IocOperations for Ioc16
IntelOperations for Intel24
Intelligence FeedsOperations for Intelligence Feeds3
Intelligence Indicator GraphOperations for Intelligence Indicator Graph1
IocsOperations for Iocs4
ReconOperations for Recon26
Tailored IntelligenceOperations for Tailored Intelligence5

Resource Details

Ioc

Operations for Ioc

Operations

OperationNameDescription
action_get_Action GetSDK: ioc.ActionGetV1
get_indicators_reportGet Indicators ReportSDK: ioc.GetIndicatorsReport
indicator_aggregate_Indicator AggregateSDK: ioc.IndicatorAggregateV1
indicator_combined_Indicator CombinedSDK: ioc.IndicatorCombinedV1
indicator_create_Indicator CreateSDK: ioc.IndicatorCreateV1
indicator_delete_Indicator DeleteSDK: ioc.IndicatorDeleteV1
indicator_get_Indicator GetSDK: ioc.IndicatorGetV1
indicator_get_device_count_Indicator Get Device CountSDK: ioc.IndicatorGetDeviceCountV1
indicator_get_devices_ran_on_Indicator Get Devices Ran OnSDK: ioc.IndicatorGetDevicesRanOnV1
indicator_get_processes_ran_on_Indicator Get Processes Ran OnSDK: ioc.IndicatorGetProcessesRanOnV1
indicator_search_Indicator SearchSDK: ioc.IndicatorSearchV1
indicator_update_Indicator UpdateSDK: ioc.IndicatorUpdateV1
list_action_List ActionSDK: ioc.ActionQueryV1
list_ioc_type_List Ioc TypeSDK: ioc.IocTypeQueryV1
list_platform_List PlatformSDK: ioc.PlatformQueryV1
list_severity_List SeveritySDK: ioc.SeverityQueryV1

Action Get

SDK: ioc.ActionGetV1

Parameters:

NameTypeRequiredDescription
idsarrayNoThe ids of the Actions to retrieve

Example:

{
"ids": ["<ids>"]
}

Get Indicators Report

SDK: ioc.GetIndicatorsReport

Parameters:

NameTypeRequiredDescription
from_parentbooleanNofrom parent. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
report_formatstringYesreport format. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
searchobjectYessearch. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"from_parent": true,
"report_format": "<report_format>",
"search": {}
}

Indicator Aggregate

SDK: ioc.IndicatorAggregateV1

Parameters:

NameTypeRequiredDescription
date_rangesobjectYesdate ranges. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
excludestringYesexclude. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
extended_boundsobjectNoextended bounds. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
fieldstringYesfield. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
filterstringYesfilter. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
fromnumberYesfrom. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
includestringYesinclude. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
intervalstringYesinterval. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
max_doc_countnumberNomax doc count. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
min_doc_countnumberNomin doc count. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
missingstringYesmissing. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
qstringYes
rangesobjectYesranges. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
sizenumberYessize. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
sortstringYessort. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
sub_aggregatesobjectYessub aggregates. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
time_zonestringYestime zone. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
typestringYestype. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"date_ranges": {},
"exclude": "<exclude>",
"extended_bounds": {},
"field": "<field>",
"filter": "<filter>",
"from": 10,
"include": "<include>",
"interval": "<interval>",
"max_doc_count": 10,
"min_doc_count": 10,
"missing": "<missing>",
"name": "<name>",
"q": "<q>",
"ranges": {},
"size": 10,
"sort": "<sort>",
"sub_aggregates": {},
"time_zone": "<time_zone>",
"type": "<type>"
}

Indicator Combined

SDK: ioc.IndicatorCombinedV1

Parameters:

NameTypeRequiredDescription
afterstringNoA pagination token used with the limit parameter to manage pagination of results. On your first...
filterstringNoThe filter expression that should be used to limit the results.
from_parentbooleanNoThe filter for returning either only indicators for the request customer or its MSSP parents
limitnumberNoThe maximum records to return.
offsetnumberNoThe offset to start retrieving records from. Offset and After params are mutually exclusive. If n...
sortstringNoThe sort expression that should be used to sort the results.

Example:

{
"after": "<after>",
"filter": "<filter>",
"from_parent": true,
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Indicator Create

SDK: ioc.IndicatorCreateV1

Parameters:

NameTypeRequiredDescription
commentstringNocomment. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
indicatorsobjectYesindicators. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"comment": "<comment>",
"indicators": {}
}

Indicator Delete

SDK: ioc.IndicatorDeleteV1

Parameters:

NameTypeRequiredDescription
commentstringNoThe comment why these indicators were deleted
filterstringNoThe FQL expression to delete Indicators in bulk. If both 'filter' and 'ids' are provided, then fi...
from_parentbooleanNoThe filter for returning either only indicators for the request customer or its MSSP parents
idsarrayNoThe ids of the Indicators to delete. If both 'filter' and 'ids' are provided, then filter takes p...

Example:

{
"comment": "<comment>",
"filter": "<filter>",
"from_parent": true,
"ids": ["<ids>"]
}

Indicator Get

SDK: ioc.IndicatorGetV1

Parameters:

NameTypeRequiredDescription
idsarrayNoThe ids of the Indicators to retrieve

Example:

{
"ids": ["<ids>"]
}

Indicator Get Device Count

SDK: ioc.IndicatorGetDeviceCountV1

Parameters:

NameTypeRequiredDescription
typestringNoThe type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length ...
valuestringNoThe string representation of the indicator

Example:

{
"type": "<type>",
"value": "<value>"
}

Indicator Get Devices Ran On

SDK: ioc.IndicatorGetDevicesRanOnV1

Parameters:

NameTypeRequiredDescription
limitstringNoThe maximum number of results to return. Use with the offset parameter to manage pagination of re...
offsetstringNoThe first process to return, where 0 is the latest offset. Use with the limit parameter to manage...
typestringNoThe type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length ...
valuestringNoThe string representation of the indicator

Example:

{
"limit": "<limit>",
"offset": "<offset>",
"type": "<type>",
"value": "<value>"
}

Indicator Get Processes Ran On

SDK: ioc.IndicatorGetProcessesRanOnV1

Parameters:

NameTypeRequiredDescription
device_idstringNoSpecify a host's ID to return only processes from that host. Get a host's ID from GET /devices/qu...
limitstringNoThe maximum number of results to return. Use with the offset parameter to manage pagination of re...
offsetstringNoThe first process to return, where 0 is the latest offset. Use with the limit parameter to manage...
typestringNoThe type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length ...
valuestringNoThe string representation of the indicator

Example:

{
"device_id": "<device_id>",
"limit": "<limit>",
"offset": "<offset>",
"type": "<type>",
"value": "<value>"
}

SDK: ioc.IndicatorSearchV1

Parameters:

NameTypeRequiredDescription
afterstringNoA pagination token used with the limit parameter to manage pagination of results. On your first...
filterstringNoThe filter expression that should be used to limit the results.
from_parentbooleanNoThe filter for returning either only indicators for the request customer or its MSSP parents
limitnumberNoThe maximum records to return.
offsetnumberNoThe offset to start retrieving records from. Offset and After params are mutually exclusive. If n...
sortstringNoThe sort expression that should be used to sort the results.

Example:

{
"after": "<after>",
"filter": "<filter>",
"from_parent": true,
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Indicator Update

SDK: ioc.IndicatorUpdateV1

Parameters:

NameTypeRequiredDescription
bulk_updateobjectYesbulk update. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
commentstringNocomment. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
indicatorsobjectYesindicators. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"bulk_update": {},
"comment": "<comment>",
"indicators": {}
}

List Action

SDK: ioc.ActionQueryV1

Parameters:

NameTypeRequiredDescription
limitnumberNoNumber of ids to return.
offsetstringNoStarting index of overall result set from which to return ids.

Example:

{
"limit": 10,
"offset": "<offset>"
}

List Ioc Type

SDK: ioc.IocTypeQueryV1

Parameters:

NameTypeRequiredDescription
limitnumberNoNumber of ids to return.
offsetstringNoStarting index of overall result set from which to return ids.

Example:

{
"limit": 10,
"offset": "<offset>"
}

List Platform

SDK: ioc.PlatformQueryV1

Parameters:

NameTypeRequiredDescription
limitnumberNoNumber of ids to return.
offsetstringNoStarting index of overall result set from which to return ids.

Example:

{
"limit": 10,
"offset": "<offset>"
}

List Severity

SDK: ioc.SeverityQueryV1

Parameters:

NameTypeRequiredDescription
limitnumberNoNumber of ids to return.
offsetstringNoStarting index of overall result set from which to return ids.

Example:

{
"limit": 10,
"offset": "<offset>"
}

Intel

Operations for Intel

Operations

OperationNameDescription
get_intel_actor_entitiesGet Intel Actor EntitiesSDK: intel.GetIntelActorEntities
get_intel_indicator_entitiesGet Intel Indicator EntitiesSDK: intel.GetIntelIndicatorEntities
get_intel_report_entitiesGet Intel Report EntitiesSDK: intel.GetIntelReportEntities
get_intel_report_pdfGet Intel Report PdfSDK: intel.GetIntelReportPDF
get_intel_rule_entitiesGet Intel Rule EntitiesSDK: intel.GetIntelRuleEntities
get_intel_rule_fileGet Intel Rule FileSDK: intel.GetIntelRuleFile
get_latest_intel_rule_fileGet Latest Intel Rule FileSDK: intel.GetLatestIntelRuleFile
get_malware_entitiesGet Malware EntitiesSDK: intel.GetMalwareEntities
get_malware_mitre_reportGet Malware Mitre ReportSDK: intel.GetMalwareMitreReport
get_mitre_reportGet Mitre ReportSDK: intel.GetMitreReport
get_vulnerabilitiesGet VulnerabilitiesSDK: intel.GetVulnerabilities
list_intel_actor_entitiesList Intel Actor EntitiesSDK: intel.QueryIntelActorEntities
list_intel_actor_idsList Intel Actor IdsSDK: intel.QueryIntelActorIds
list_intel_indicator_entitiesList Intel Indicator EntitiesSDK: intel.QueryIntelIndicatorEntities
list_intel_indicator_idsList Intel Indicator IdsSDK: intel.QueryIntelIndicatorIds
list_intel_report_entitiesList Intel Report EntitiesSDK: intel.QueryIntelReportEntities
list_intel_report_idsList Intel Report IdsSDK: intel.QueryIntelReportIds
list_intel_rule_idsList Intel Rule IdsSDK: intel.QueryIntelRuleIds
list_malwareList MalwareSDK: intel.QueryMalware
list_malware_entitiesList Malware EntitiesSDK: intel.QueryMalwareEntities
list_mitre_attacksList Mitre AttacksSDK: intel.QueryMitreAttacks
list_mitre_attacks_for_malwareList Mitre Attacks For MalwareSDK: intel.QueryMitreAttacksForMalware
list_vulnerabilitiesList VulnerabilitiesSDK: intel.QueryVulnerabilities
post_mitre_attacksPost Mitre AttacksSDK: intel.PostMitreAttacks

Get Intel Actor Entities

SDK: intel.GetIntelActorEntities

Parameters:

NameTypeRequiredDescription
fieldsarrayNoThe fields to return, or a predefined set of fields in the form of the collection name surrounded...
idsarrayNoThe IDs of the actors you want to retrieve.

Example:

{
"fields": ["<fields>"],
"ids": ["<ids>"]
}

Get Intel Indicator Entities

SDK: intel.GetIntelIndicatorEntities

Parameters:

NameTypeRequiredDescription
idsarrayYesids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

Get Intel Report Entities

SDK: intel.GetIntelReportEntities

Parameters:

NameTypeRequiredDescription
fieldsarrayNoThe fields to return, or a predefined set of fields in the form of the collection name surrounded...
idsarrayNoThe IDs of the reports you want to retrieve.

Example:

{
"fields": ["<fields>"],
"ids": ["<ids>"]
}

Get Intel Report Pdf

SDK: intel.GetIntelReportPDF

Parameters:

NameTypeRequiredDescription
idstringNoThe ID of the report you want to download as a PDF.
idsstringNoThe ID of the report you want to download as a PDF. This parameter is used only if no id paramete...

Example:

{
"id": "<id>",
"ids": "<ids>"
}

Get Intel Rule Entities

SDK: intel.GetIntelRuleEntities

Parameters:

NameTypeRequiredDescription
idsarrayNoThe ids of rules to return.

Example:

{
"ids": ["<ids>"]
}

Get Intel Rule File

SDK: intel.GetIntelRuleFile

Parameters:

NameTypeRequiredDescription
acceptstringNoChoose the format you want the rule set in.
formatstringNoChoose the format you want the rule set in. Valid formats are zip and gzip. Defaults to zip.
idnumberNoThe ID of the rule set.

Example:

{
"accept": "<accept>",
"format": "<format>",
"id": 10
}

Get Latest Intel Rule File

SDK: intel.GetLatestIntelRuleFile

Parameters:

NameTypeRequiredDescription
acceptstringNoChoose the format you want the rule set in.
if_modified_sincestringNoDownload Only if changed since
if_none_matchstringNoDownload the latest rule set only if it doesn't have an ETag matching the given ones.
formatstringNoChoose the format you want the rule set in. Valid formats are zip and gzip. Defaults to zip.
typestringNosnort-suricata-changelog yara-master yara-update yara-changelog common-event-format netwitness cq...

Example:

{
"accept": "<accept>",
"if_modified_since": "<if_modified_since>",
"if_none_match": "<if_none_match>",
"format": "<format>",
"type": "<type>"
}

Get Malware Entities

SDK: intel.GetMalwareEntities

Parameters:

NameTypeRequiredDescription
idsarrayNoMalware family name in lower case with spaces, dots and slashes replaced with dashes

Example:

{
"ids": ["<ids>"]
}

Get Malware Mitre Report

SDK: intel.GetMalwareMitreReport

Parameters:

NameTypeRequiredDescription
xcsuseruuidstringNoUser id
formatstringNoSupported report formats: CSV, JSON or JSON_NAVIGATOR
idstringNoMalware family name in lower case with spaces replaced with dashes

Example:

{
"xcsuseruuid": "<xcsuseruuid>",
"format": "<format>",
"id": "<id>"
}

Get Mitre Report

SDK: intel.GetMitreReport

Parameters:

NameTypeRequiredDescription
actor_idstringNoActor ID(derived from the actor's name)
formatstringNoSupported report formats: CSV or JSON

Example:

{
"actor_id": "<actor_id>",
"format": "<format>"
}

Get Vulnerabilities

SDK: intel.GetVulnerabilities

Parameters:

NameTypeRequiredDescription
idsarrayYesids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

List Intel Actor Entities

SDK: intel.QueryIntelActorEntities

Parameters:

NameTypeRequiredDescription
fieldsarrayNoThe fields to return, or a predefined set of fields in the form of the collection name surrounded...
filterstringNoFilter your query by specifying FQL filter parameters. Filter parameters include: actor_type, ani...
limitnumberNoSet the number of actors to return. The value must be between 1 and 5000.
offsetnumberNoSet the starting row number to return actors from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date

Example:

{
"fields": ["<fields>"],
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Intel Actor Ids

SDK: intel.QueryIntelActorIds

Parameters:

NameTypeRequiredDescription
filterstringNoFilter your query by specifying FQL filter parameters. Filter parameters include: actor_type, ani...
limitnumberNoSet the number of actor IDs to return. The value must be between 1 and 5000.
offsetnumberNoSet the starting row number to return actors IDs from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Intel Indicator Entities

SDK: intel.QueryIntelIndicatorEntities

Parameters:

NameTypeRequiredDescription
filterstringNoFilter your query by specifying FQL filter parameters. Filter parameters include: _marker, actors...
include_deletedbooleanNoIf true, include both published and deleted indicators in the response. Defaults to false.
include_relationsbooleanNoIf true, include related indicators in the response. Defaults to true.
limitnumberNoSet the number of indicators to return. The number must be between 1 and 10000
offsetnumberNoSet the starting row number to return indicators from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: published_date

Example:

{
"filter": "<filter>",
"include_deleted": true,
"include_relations": true,
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Intel Indicator Ids

SDK: intel.QueryIntelIndicatorIds

Parameters:

NameTypeRequiredDescription
filterstringNoFilter your query by specifying FQL filter parameters. Filter parameters include: _marker, actors...
include_deletedbooleanNoIf true, include both published and deleted indicators in the response. Defaults to false.
include_relationsbooleanNoIf true, include related indicators in the response. Defaults to true.
limitnumberNoSet the number of indicator IDs to return. The number must be between 1 and 10000
offsetnumberNoSet the starting row number to return indicator IDs from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: published_date

Example:

{
"filter": "<filter>",
"include_deleted": true,
"include_relations": true,
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Intel Report Entities

SDK: intel.QueryIntelReportEntities

Parameters:

NameTypeRequiredDescription
fieldsarrayNoThe fields to return, or a predefined set of fields in the form of the collection name surrounded...
filterstringNoFilter your query by specifying FQL filter parameters. Filter parameters include: actors, actors....
limitnumberNoSet the number of reports to return. The value must be between 1 and 5000.
offsetnumberNoSet the starting row number to return reports from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date

Example:

{
"fields": ["<fields>"],
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Intel Report Ids

SDK: intel.QueryIntelReportIds

Parameters:

NameTypeRequiredDescription
filterstringNoFilter your query by specifying FQL filter parameters. Filter parameters include: actors, actors....
limitnumberNoSet the number of report IDs to return. The value must be between 1 and 5000.
offsetnumberNoSet the starting row number to return report IDs from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Intel Rule Ids

SDK: intel.QueryIntelRuleIds

Parameters:

NameTypeRequiredDescription
descriptionarrayNoSubstring match on description field.
limitnumberNoThe number of rule IDs to return. Defaults to 10.
max_created_datestringNoFilter results to those created on or before a certain date.
min_created_datenumberNoFilter results to those created on or after a certain date.
namearrayNoSearch by rule title.
offsetnumberNoSet the starting row number to return reports from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date
tagsarrayNoSearch for rule tags.
typestringNosnort-suricata-changelog yara-master yara-update yara-changelog common-event-format netwitness cq...

Example:

{
"description": ["<description>"],
"limit": 10,
"max_created_date": "<max_created_date>",
"min_created_date": 10,
"name": ["<name>"],
"offset": 10,
"sort": "<sort>",
"tags": ["<tags>"],
"type": "<type>"
}

List Malware

SDK: intel.QueryMalware

Parameters:

NameTypeRequiredDescription
filterstringNoFilter your query by specifying FQL filter parameters.
limitnumberNoSet the number of malware IDs to return. The value must be between 1 and 5000.
offsetnumberNoSet the starting row number to return malware IDs from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Malware Entities

SDK: intel.QueryMalwareEntities

Parameters:

NameTypeRequiredDescription
fieldsarrayNoThe fields to return
filterstringNoFilter your query by specifying FQL filter parameters.
limitnumberNoSet the number of malware IDs to return. The value must be between 1 and 5000.
offsetnumberNoSet the starting row number to return malware IDs from. Defaults to 0.
sortstringNoOrder fields in ascending or descending order. Ex: created_date

Example:

{
"fields": ["<fields>"],
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Mitre Attacks

SDK: intel.QueryMitreAttacks

Parameters:

NameTypeRequiredDescription
idstringNoThe actor ID(derived from the actor's name) for which to retrieve a list of attacks, for example:...
idsarrayNoThe actor ID(derived from the actor's name) for which to retrieve a list of attacks, for example:...

Example:

{
"id": "<id>",
"ids": ["<ids>"]
}

List Mitre Attacks For Malware

SDK: intel.QueryMitreAttacksForMalware

Parameters:

NameTypeRequiredDescription
idsarrayNoMalware family name in lower case with spaces replaced with dashes

Example:

{
"ids": ["<ids>"]
}

List Vulnerabilities

SDK: intel.QueryVulnerabilities

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query specifying the filter parameters. Filter parameters include: _all, affected_products.pr...
limitnumberNoNumber of IDs to return.
offsetstringNoStarting index of result set from which to return IDs.
sortstringNoOrder by fields.

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": "<offset>",
"sort": "<sort>"
}

Post Mitre Attacks

SDK: intel.PostMitreAttacks

Parameters:

NameTypeRequiredDescription
idsarrayYesids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

Intelligence Feeds

Operations for Intelligence Feeds

Operations

OperationNameDescription
download_feed_archiveDownload Feed ArchiveSDK: intelligence_feeds.DownloadFeedArchive
list_feed_archivesList Feed ArchivesSDK: intelligence_feeds.QueryFeedArchives
list_feed_typesList Feed TypesSDK: intelligence_feeds.ListFeedTypes

Download Feed Archive

SDK: intelligence_feeds.DownloadFeedArchive

Parameters:

NameTypeRequiredDescription
feed_item_idstringNoFeed ID

Example:

{
"feed_item_id": "<feed_item_id>"
}

List Feed Archives

SDK: intelligence_feeds.QueryFeedArchives

Parameters:

NameTypeRequiredDescription
feed_intervalstringNoFeed interval must be one of: - dump: Complete historical data snapshot - daily: Daily aggregated...
feed_namestringNoFeed Name. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
sincestringNoSince is a valid timestamp in RFC3399 format. Restrictions: minutely: now()-2h, hourly: now()-2d,...

Example:

{
"feed_interval": "<feed_interval>",
"feed_name": "<feed_name>",
"since": "<since>"
}

List Feed Types

SDK: intelligence_feeds.ListFeedTypes

This operation has no parameters.

Example:

{
}

Intelligence Indicator Graph

Operations for Intelligence Indicator Graph

Operations

OperationNameDescription
search_indicatorsSearch IndicatorsSDK: intelligence_indicator_graph.SearchIndicators

Search Indicators

SDK: intelligence_indicator_graph.SearchIndicators

Parameters:

NameTypeRequiredDescription
filterstringYesfilter. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
sortobjectYessort. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"filter": "<filter>",
"sort": {}
}

Iocs

Operations for Iocs

Operations

OperationNameDescription
devices_countDevices CountSDK: iocs.DevicesCount
devices_ran_onDevices Ran OnSDK: iocs.DevicesRanOn
entities_processesEntities ProcessesSDK: iocs.EntitiesProcesses
processes_ran_onProcesses Ran OnSDK: iocs.ProcessesRanOn

Devices Count

SDK: iocs.DevicesCount

Parameters:

NameTypeRequiredDescription
typestringNoThe type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length ...
valuestringNoThe string representation of the indicator

Example:

{
"type": "<type>",
"value": "<value>"
}

Devices Ran On

SDK: iocs.DevicesRanOn

Parameters:

NameTypeRequiredDescription
limitstringNoThe first process to return, where 0 is the latest offset. Use with the offset parameter to manag...
offsetstringNoThe first process to return, where 0 is the latest offset. Use with the limit parameter to manage...
typestringNoThe type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length ...
valuestringNoThe string representation of the indicator

Example:

{
"limit": "<limit>",
"offset": "<offset>",
"type": "<type>",
"value": "<value>"
}

Entities Processes

SDK: iocs.EntitiesProcesses

Parameters:

NameTypeRequiredDescription
idsarrayNoProcessID for the running process you want to lookup

Example:

{
"ids": ["<ids>"]
}

Processes Ran On

SDK: iocs.ProcessesRanOn

Parameters:

NameTypeRequiredDescription
device_idstringNoSpecify a host's ID to return only processes from that host. Get a host's ID from GET /devices/qu...
limitstringNoThe first process to return, where 0 is the latest offset. Use with the offset parameter to manag...
offsetstringNoThe first process to return, where 0 is the latest offset. Use with the limit parameter to manage...
typestringNoThe type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length ...
valuestringNoThe string representation of the indicator

Example:

{
"device_id": "<device_id>",
"limit": "<limit>",
"offset": "<offset>",
"type": "<type>",
"value": "<value>"
}

Recon

Operations for Recon

Operations

OperationNameDescription
aggregate_notifications_Aggregate NotificationsSDK: recon.AggregateNotificationsV1
aggregate_notifications_exposed_data_records_Aggregate Notifications Exposed Data RecordsSDK: recon.AggregateNotificationsExposedDataRecordsV1
create_actions_Create ActionsSDK: recon.CreateActionsV1
create_export_jobs_Create Export JobsSDK: recon.CreateExportJobsV1
create_rules_Create RulesSDK: recon.CreateRulesV1
delete_action_Delete ActionSDK: recon.DeleteActionV1
delete_export_jobs_Delete Export JobsSDK: recon.DeleteExportJobsV1
delete_notifications_Delete NotificationsSDK: recon.DeleteNotificationsV1
delete_rules_Delete RulesSDK: recon.DeleteRulesV1
get_actions_Get ActionsSDK: recon.GetActionsV1
get_export_jobs_Get Export JobsSDK: recon.GetExportJobsV1
get_file_content_for_export_jobs_Get File Content For Export JobsSDK: recon.GetFileContentForExportJobsV1
get_notifications_Get NotificationsSDK: recon.GetNotificationsV1
get_notifications_detailed_Get Notifications DetailedSDK: recon.GetNotificationsDetailedV1
get_notifications_detailed_translated_Get Notifications Detailed TranslatedSDK: recon.GetNotificationsDetailedTranslatedV1
get_notifications_exposed_data_records_Get Notifications Exposed Data RecordsSDK: recon.GetNotificationsExposedDataRecordsV1
get_notifications_translated_Get Notifications TranslatedSDK: recon.GetNotificationsTranslatedV1
get_rules_Get RulesSDK: recon.GetRulesV1
list_actions_List ActionsSDK: recon.QueryActionsV1
list_notifications_List NotificationsSDK: recon.QueryNotificationsV1
list_notifications_exposed_data_records_List Notifications Exposed Data RecordsSDK: recon.QueryNotificationsExposedDataRecordsV1
list_rules_List RulesSDK: recon.QueryRulesV1
preview_rule_Preview RuleSDK: recon.PreviewRuleV1
update_action_Update ActionSDK: recon.UpdateActionV1
update_notifications_Update NotificationsSDK: recon.UpdateNotificationsV1
update_rules_Update RulesSDK: recon.UpdateRulesV1

Aggregate Notifications

SDK: recon.AggregateNotificationsV1

Parameters:

NameTypeRequiredDescription
bodyobjectNoBody.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"body": {}
}

Aggregate Notifications Exposed Data Records

SDK: recon.AggregateNotificationsExposedDataRecordsV1

Parameters:

NameTypeRequiredDescription
bodyobjectNoBody.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"body": {}
}

Create Actions

SDK: recon.CreateActionsV1

Parameters:

NameTypeRequiredDescription
actionsobjectYesactions. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
rule_idstringYesrule id. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"actions": {},
"rule_id": "<rule_id>"
}

Create Export Jobs

SDK: recon.CreateExportJobsV1

Parameters:

NameTypeRequiredDescription
bodyobjectNoBody.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"body": {}
}

Create Rules

SDK: recon.CreateRulesV1

Parameters:

NameTypeRequiredDescription
bodyobjectNoBody.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"body": {}
}

Delete Action

SDK: recon.DeleteActionV1

Parameters:

NameTypeRequiredDescription
idstringNoID of the action.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...

Example:

{
"id": "<id>"
}

Delete Export Jobs

SDK: recon.DeleteExportJobsV1

Parameters:

NameTypeRequiredDescription
idsarrayNoExport Job IDs.

Example:

{
"ids": ["<ids>"]
}

Delete Notifications

SDK: recon.DeleteNotificationsV1

Parameters:

NameTypeRequiredDescription
idsarrayNoNotifications IDs.

Example:

{
"ids": ["<ids>"]
}

Delete Rules

SDK: recon.DeleteRulesV1

Parameters:

NameTypeRequiredDescription
idsarrayNoIDs of rules.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
notifications_deletion_requestedbooleanNoWhether we should delete the notifications generated by this rule or not

Example:

{
"ids": ["<ids>"],
"notifications_deletion_requested": true
}

Get Actions

SDK: recon.GetActionsV1

Parameters:

NameTypeRequiredDescription
idsarrayNoAction IDs.

Example:

{
"ids": ["<ids>"]
}

Get Export Jobs

SDK: recon.GetExportJobsV1

Parameters:

NameTypeRequiredDescription
idsarrayNoExport Job IDs.

Example:

{
"ids": ["<ids>"]
}

Get File Content For Export Jobs

SDK: recon.GetFileContentForExportJobsV1

Parameters:

NameTypeRequiredDescription
idstringNoExport Job ID.

Example:

{
"id": "<id>"
}

Get Notifications

SDK: recon.GetNotificationsV1

Parameters:

NameTypeRequiredDescription
idsarrayNoNotification IDs.

Example:

{
"ids": ["<ids>"]
}

Get Notifications Detailed

SDK: recon.GetNotificationsDetailedV1

Parameters:

NameTypeRequiredDescription
idsarrayNoNotification IDs.

Example:

{
"ids": ["<ids>"]
}

Get Notifications Detailed Translated

SDK: recon.GetNotificationsDetailedTranslatedV1

Parameters:

NameTypeRequiredDescription
idsarrayNoNotification IDs.

Example:

{
"ids": ["<ids>"]
}

Get Notifications Exposed Data Records

SDK: recon.GetNotificationsExposedDataRecordsV1

Parameters:

NameTypeRequiredDescription
idsarrayNoNotification exposed records IDs.

Example:

{
"ids": ["<ids>"]
}

Get Notifications Translated

SDK: recon.GetNotificationsTranslatedV1

Parameters:

NameTypeRequiredDescription
idsarrayNoNotification IDs.

Example:

{
"ids": ["<ids>"]
}

Get Rules

SDK: recon.GetRulesV1

Parameters:

NameTypeRequiredDescription
idsarrayNoIDs of rules.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

List Actions

SDK: recon.QueryActionsV1

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query to filter actions by. Possible filter properties are: [id cid user_uuid rule_id type fr...
limitnumberNoNumber of IDs to return. Offset + limit should NOT be above 10K.
offsetnumberNoStarting index of overall result set from which to return IDs.
sortstringNoPossible order by fields: created_timestamp, updated_timestamp. Ex: 'updated_timestamp

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Notifications

SDK: recon.QueryNotificationsV1

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query to filter notifications by. Possible filter properties are: [id cid user_uuid status ru...
limitnumberNoNumber of IDs to return. Offset + limit should NOT be above 10K.
offsetnumberNoStarting index of overall result set from which to return IDs.
sortstringNoPossible order by fields: created_date, updated_date. Ex: `updated_date

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Notifications Exposed Data Records

SDK: recon.QueryNotificationsExposedDataRecordsV1

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query to filter notifications by. Possible filter properties are: [id cid user_uuid created_d...
limitnumberNoNumber of IDs to return. Offset + limit should NOT be above 10K.
offsetnumberNoStarting index of overall result set from which to return ids.
sortstringNoPossible order by fields: created_date, updated_date. Ex: 'updated_date

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Rules

SDK: recon.QueryRulesV1

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query to filter rules by. Possible filter properties are: [id cid user_uuid topic priority pe...
limitnumberNoNumber of IDs to return. Offset + limit should NOT be above 10K.
offsetnumberNoStarting index of overall result set from which to return IDs.
secondary_sortstringNoPossible order by fields: created_timestamp, last_updated_timestamp. Ex: `last_updated_timestamp
sortstringNoPossible order by fields: created_timestamp, last_updated_timestamp. Ex: `last_updated_timestamp

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"secondary_sort": "<secondary_sort>",
"sort": "<sort>"
}

Preview Rule

SDK: recon.PreviewRuleV1

Parameters:

NameTypeRequiredDescription
filterstringYesfilter. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
topicstringYestopic. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"filter": "<filter>",
"topic": "<topic>"
}

Update Action

SDK: recon.UpdateActionV1

Parameters:

NameTypeRequiredDescription
content_formatstringYescontent format. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
frequencystringYesfrequency. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idstringYes
recipientsarrayYesrecipients. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
statusstringYesstatus. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
trigger_matchlessbooleanYestrigger matchless. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...

Example:

{
"content_format": "<content_format>",
"frequency": "<frequency>",
"id": "<id>",
"recipients": ["<recipients>"],
"status": "<status>",
"trigger_matchless": true
}

Update Notifications

SDK: recon.UpdateNotificationsV1

Parameters:

NameTypeRequiredDescription
bodyobjectNoBody.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"body": {}
}

Update Rules

SDK: recon.UpdateRulesV1

Parameters:

NameTypeRequiredDescription
bodyobjectNoBody.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"body": {}
}

Tailored Intelligence

Operations for Tailored Intelligence

Operations

OperationNameDescription
get_events_bodyGet Events BodySDK: tailored_intelligence.GetEventsBody
get_events_entitiesGet Events EntitiesSDK: tailored_intelligence.GetEventsEntities
get_rules_entitiesGet Rules EntitiesSDK: tailored_intelligence.GetRulesEntities
list_eventsList EventsSDK: tailored_intelligence.QueryEvents
list_rulesList RulesSDK: tailored_intelligence.QueryRules

Get Events Body

SDK: tailored_intelligence.GetEventsBody

Parameters:

NameTypeRequiredDescription
idstringNoReturn the event body for event id.

Example:

{
"id": "<id>"
}

Get Events Entities

SDK: tailored_intelligence.GetEventsEntities

Parameters:

NameTypeRequiredDescription
idsarrayYesids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

Get Rules Entities

SDK: tailored_intelligence.GetRulesEntities

Parameters:

NameTypeRequiredDescription
idsarrayYesids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

List Events

SDK: tailored_intelligence.QueryEvents

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query specifying the filter parameters. Special value '*' means to not filter on anything.
limitnumberNoNumber of ids to return.
offsetstringNoStarting index of overall result set from which to return ids.
sortstringNoPossible order by fields: source_type, created_date, updated_date. Ex: 'updated_date

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": "<offset>",
"sort": "<sort>"
}

List Rules

SDK: tailored_intelligence.QueryRules

Parameters:

NameTypeRequiredDescription
filterstringNoFQL query specifying the filter parameters. Special value '*' means to not filter on anything.
limitnumberNoNumber of ids to return.
offsetstringNoStarting index of overall result set from which to return ids.
sortstringNoPossible order by fields: name, value, rule_type, customer_id, created_date, updated_date. Ex: 'u...

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": "<offset>",
"sort": "<sort>"
}

Best Practices

  1. Use Appropriate Filters: Leverage FQL (Falcon Query Language) filters to narrow down results and improve performance.

  2. Implement Pagination: For operations returning large datasets, use limit and offset parameters to paginate results.

  3. Handle Rate Limits: CrowdStrike APIs have rate limits. Implement appropriate delays and retry logic in your workflows.

  4. Secure Credentials: Never log or expose API credentials. Use NINA's credential management for secure storage.

  5. Use Specific Scopes: When creating API clients, only request the minimum required API scopes.

  6. Monitor API Usage: Track your API usage to avoid hitting rate limits during critical operations.

  7. Validate IDs: Always validate resource IDs before using them in update or delete operations.

  8. Error Handling: Implement comprehensive error handling for API failures and unexpected responses.

Troubleshooting

IssuePossible Solution
401 UnauthorizedVerify Client ID and Client Secret are correct; check if credentials have expired
403 ForbiddenEnsure API client has required scopes for the operation
404 Not FoundVerify the resource ID exists and is accessible with your credentials
429 Too Many RequestsRate limit exceeded; implement delays between requests
Invalid FilterCheck FQL syntax; refer to CrowdStrike FQL documentation
Connection TimeoutVerify network connectivity and correct Base URL for your region
Empty ResultsVerify filter criteria; check if resources exist in your environment

Support

For issues with this integration, please contact support with:

  • The operation you were attempting
  • Any error messages received
  • The parameters used (excluding sensitive data)
  • Your CrowdStrike cloud region

For CrowdStrike API documentation, visit: CrowdStrike Developer Portal

Updated: 2026-02-05