CrowdStrike is a cybersecurity platform providing endpoint protection, threat intelligence, and identity security through its Falcon suite. This integration authenticates with a Falcon API client ID and secret against a chosen cloud region and covers the Alerts, Hosts, Host Groups, IOC Management, Spotlight, Real Time Response, Case Management, and Identity Protection APIs.
With this integration, you can:
- Triage alerts: Search Falcon alerts with Falcon Query Language, pull full alert records by composite ID, and update status, assignment, tags, comments, and console visibility
- Respond on hosts: Contain or lift containment on a host, and hide or unhide it from the Falcon console
- Manage host groups: Search groups, read group details, and add or remove hosts from static groups
- Manage custom indicators: Search, read, create, update, and delete indicators of compromise
- Review vulnerabilities: Query Spotlight vulnerabilities and read CVE, host, application, and remediation details
- Run read-only Real Time Response: Open a session, run a documented read-only command, poll for output, and close the session
- Read cases: Search Case Management cases and read case details
- Query identity sensors: Search Identity Protection sensors, fetch sensor details, and run aggregate queries
Each operation maps to a specific Falcon API scope — for example Alerts: Read and Alerts: Write, Hosts: Write for containment, Host groups: Read/Write, IOC Management: Read/Write, Vulnerabilities: Read, Real time response: Read, and Cases: Read. Containment and indicator deletion change live protection behavior, so scope the credential to only the operations your workflows need.
Note that CrowdStrike decommissioned the legacy Detects API (September 30, 2025) and the CrowdScore Incidents API (March 9, 2026). This integration uses the current Alerts API and Case Management API in their place.
Integrate CrowdStrike Falcon into workflows to triage alerts, contain hosts, manage host groups and custom indicators of compromise, review Spotlight vulnerabilities, run read-only Real Time Response commands, read Case Management cases, and query Identity Protection sensors.
Create custom CrowdStrike Falcon indicators of compromise (POST /iocs/entities/indicators/v1). Each indicator can allow, detect, or block activity across the fleet, so a wrong value can suppress detections or break legitimate software. Requires the "IOC Management: Write" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
indicators | json | Yes | JSON array of indicators to create. Each entry requires type, value, and applied_globally (boolean). type is one of sha256, md5, domain, ipv4, ipv6; action is one of no_action, allow, prevent, detect (prevent_no_ui is widely reported and appears in the Falcon console, but CrowdStrike does not enumerate it in the IOC API docs - call GET /iocs/queries/actions/v1 to read the actions your tenant actually accepts); severity is one of informational, low, medium, high, critical; platforms entries are windows, mac, or linux. Other documented fields: host_groups (array), description, source, tags (array), expiration (ISO 8601), mobile_action, metadata ({ filename }). Either applied_globally must be true or host_groups must be supplied. Tenants can extend these value sets, so treat them as the documented defaults rather than a closed list. |
comment | string | No | Audit comment explaining why these indicators were created |
retrodetects | boolean | No | Whether to generate retroactive detections for the new indicators |
ignoreWarnings | boolean | No | Whether to create the indicators even when CrowdStrike returns warnings |
| Parameter | Type | Description |
|---|
indicators | array | Created CrowdStrike indicator records |
↳ id | string | Indicator identifier |
↳ type | string | Indicator type |
↳ value | string | Indicator value |
↳ action | string | Action taken when the indicator matches |
↳ mobileAction | string | Action taken on mobile platforms when the indicator matches |
↳ severity | string | Indicator severity |
↳ description | string | Indicator description |
↳ source | string | Indicator source |
↳ appliedGlobally | boolean | Whether the indicator applies to all hosts |
↳ platforms | array | Platforms the indicator applies to |
↳ hostGroups | array | Host group IDs the indicator is scoped to |
↳ tags | array | Tags applied to the indicator |
↳ expiration | string | Indicator expiration timestamp |
↳ expired | boolean | Whether the indicator has expired |
↳ deleted | boolean | Whether the indicator is deleted |
↳ fromParent | boolean | Whether the indicator was inherited from a parent CID |
↳ parentCidName | string | Parent CID name |
↳ createdBy | string | User who created the indicator |
↳ createdOn | string | Indicator creation timestamp |
↳ modifiedBy | string | User who last modified the indicator |
↳ modifiedOn | string | Indicator modification timestamp |
↳ metadata | json | File metadata CrowdStrike resolved for the indicator |
↳ avHits | number | Antivirus hit count |
↳ companyName | string | Company name |
↳ fileDescription | string | File description |
↳ fileVersion | string | File version |
↳ filename | string | File name |
↳ originalFilename | string | Original file name |
↳ productName | string | Product name |
↳ productVersion | string | Product version |
↳ signed | boolean | Whether the file is signed |
count | number | Number of indicators created |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Permanently delete custom CrowdStrike Falcon indicators of compromise (DELETE /iocs/entities/indicators/v1). Cannot be undone; deleting a blocking indicator removes that protection from every host, and a broad filter can delete far more than intended. Supply an ID list or a filter, never both -- CrowdStrike lets a filter silently override the IDs, so this tool rejects that instead. Requires the "IOC Management: Write" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
indicatorIds | json | No | JSON array of CrowdStrike IOC IDs to delete. Cannot be combined with a filter. |
filter | string | No | Falcon Query Language filter selecting indicators to delete in bulk. Cannot be combined with an ID list. |
comment | string | No | Audit comment explaining why these indicators were deleted |
| Parameter | Type | Description |
|---|
deletedIds | array | IOC IDs CrowdStrike deleted |
count | number | Number of indicators deleted |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Close an open CrowdStrike Falcon Real Time Response session (DELETE /real-time-response/entities/sessions/v1). Requires the "Real time response: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
sessionId | string | Yes | RTR session ID to close |
| Parameter | Type | Description |
|---|
sessionId | string | RTR session ID that was closed |
deleted | boolean | Whether CrowdStrike accepted the session deletion |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Run a read-only Real Time Response command in an open CrowdStrike Falcon session (POST /real-time-response/entities/command/v1). baseCommand names the family only (cat, cd, clear, csrutil, env, eventlog, filehash, getsid, help, history, ifconfig, ipconfig, ls, mount, netstat, ps, reg, users); subcommands go in commandString. Host-modifying commands need the Active Responder or Admin endpoints. Requires the "Real time response: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
sessionId | string | Yes | RTR session ID returned by Init RTR Session |
baseCommand | string | Yes | Read-only RTR base command family, one of: cat, cd, clear, csrutil, env, eventlog, filehash, getsid, help, history, ifconfig, ipconfig, ls, mount, netstat, ps, reg, users. Subcommands belong in commandString, not here — and only reg query is read-tier, since reg set and reg delete are Active Responder commands. |
commandString | string | Yes | Full command line to run, such as "ls C:\Windows" or "reg query HKLM\Software" |
| Parameter | Type | Description |
|---|
cloudRequestId | string | Cloud request ID to poll for command output |
sessionId | string | RTR session the command ran in |
queuedCommandOffline | boolean | Whether the command was queued for an offline host |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get full CrowdStrike Falcon alert records for one or more composite alert IDs (POST /alerts/entities/alerts/v2). Requires the "Alerts: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
compositeIds | json | Yes | JSON array of CrowdStrike composite alert IDs |
includeHidden | boolean | No | Include previously hidden alerts (CrowdStrike defaults this to true) |
| Parameter | Type | Description |
|---|
alerts | array | CrowdStrike alert records |
↳ compositeId | string | Composite alert ID |
↳ id | string | Alert ID |
↳ cid | string | CrowdStrike customer identifier |
↳ aggregateId | string | Aggregate identifier |
↳ agentId | string | Agent (sensor) identifier |
↳ deviceId | string | Device identifier from the alert device |
↳ hostname | string | Hostname from the alert device |
↳ name | string | Alert name |
↳ displayName | string | Alert display name |
↳ description | string | Alert description |
↳ type | string | Alert type |
↳ product | string | Falcon product that raised the alert |
↳ platform | string | Platform the alert was raised on |
↳ severity | number | Numeric severity |
↳ severityName | string | Severity name |
↳ confidence | number | Confidence score |
↳ status | string | Alert status |
↳ assignedToName | string | Assignee display name |
↳ assignedToUid | string | Assignee user ID |
↳ assignedToUuid | string | Assignee user UUID |
↳ tactic | string | MITRE ATT&CK tactic |
↳ tacticId | string | MITRE ATT&CK tactic ID |
↳ technique | string | MITRE ATT&CK technique |
↳ techniqueId | string | MITRE ATT&CK technique ID |
↳ scenario | string | Alert scenario |
↳ objective | string | Adversary objective |
↳ resolution | string | Alert resolution |
↳ showInUi | boolean | Whether the alert is shown in Falcon |
↳ tags | array | Tags applied to the alert |
↳ filename | string | Triggering file name |
↳ filepath | string | Triggering file path |
↳ cmdline | string | Triggering command line |
↳ sha256 | string | SHA256 of the triggering file |
↳ sha1 | string | SHA1 of the triggering file |
↳ md5 | string | MD5 of the triggering file |
↳ userName | string | User name associated with the alert |
↳ userId | string | User ID associated with the alert |
↳ patternId | number | Detection pattern ID |
↳ falconHostLink | string | Deep link into the Falcon console |
↳ controlGraphId | string | Control graph identifier |
↳ external | boolean | Whether the alert is external |
↳ emailSent | boolean | Whether a notification email was sent |
↳ isAggregated | boolean | Whether the alert is aggregated |
↳ isFalconPlatformIoa | boolean | Whether the alert is a Falcon platform IOA |
↳ dataDomains | array | Data domains the alert belongs to |
↳ iocValues | array | Indicator values associated with the alert |
↳ linkedCaseIds | array | Case IDs linked to the alert |
↳ linkedBehavioralDetections | array | Behavioral detection IDs linked to the alert |
↳ timestamp | string | Alert timestamp |
↳ createdTimestamp | string | Alert creation timestamp |
↳ updatedTimestamp | string | Alert update timestamp |
↳ crawledTimestamp | string | Alert crawl timestamp |
↳ contextTimestamp | string | Alert context timestamp |
count | number | Number of alerts returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get CrowdStrike Falcon Case Management case records for one or more case IDs (POST /cases/entities/cases/v2). Requires the "Cases: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
caseIds | json | Yes | JSON array of CrowdStrike case IDs |
| Parameter | Type | Description |
|---|
cases | array | CrowdStrike Case Management case records |
↳ id | string | Case identifier |
↳ cid | string | CrowdStrike customer identifier |
↳ name | string | Case name |
↳ description | string | Case description |
↳ descriptionFormat | string | Format of the case description |
↳ status | string | Case status |
↳ severity | number | Numeric case severity |
↳ severityLevel | string | Case severity level name |
↳ referenceId | string | Human-readable case reference ID |
↳ version | number | Case version for optimistic concurrency |
↳ tags | array | Tags applied to the case |
↳ assignedTo | json | Falcon user the case is assigned to |
↳ uuid | string | Falcon user UUID |
↳ email | string | Falcon user email |
↳ fullName | string | Falcon user full name |
↳ createdBy | json | Falcon user who created the case |
↳ uuid | string | Falcon user UUID |
↳ email | string | Falcon user email |
↳ fullName | string | Falcon user full name |
↳ lastUpdatedBy | json | Falcon user who last updated the case |
↳ uuid | string | Falcon user UUID |
↳ email | string | Falcon user email |
↳ fullName | string | Falcon user full name |
↳ createdTimestamp | string | Case creation timestamp |
↳ updatedTimestamp | string | Case update timestamp |
↳ startTimestamp | string | Case start timestamp |
↳ endTimestamp | string | Case end timestamp |
↳ templateId | string | Case template identifier |
↳ templateName | string | Case template name |
↳ slaId | string | SLA identifier applied to the case |
↳ slaName | string | SLA name applied to the case |
↳ isReadOnly | boolean | Whether the case is read only |
count | number | Number of cases returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get CrowdStrike Falcon host group records for one or more group IDs (GET /devices/entities/host-groups/v1). Requires the "Host groups: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
hostGroupIds | json | Yes | JSON array of CrowdStrike host group IDs |
| Parameter | Type | Description |
|---|
hostGroups | array | CrowdStrike host group records |
↳ id | string | Host group identifier |
↳ name | string | Host group name |
↳ description | string | Host group description |
↳ groupType | string | Group type (static, dynamic, staticByID) |
↳ assignmentRule | string | FQL assignment rule for dynamic groups |
↳ createdBy | string | User who created the group |
↳ createdTimestamp | string | Group creation timestamp |
↳ modifiedBy | string | User who last modified the group |
↳ modifiedTimestamp | string | Group modification timestamp |
count | number | Number of host groups returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get custom CrowdStrike Falcon indicator of compromise (IOC) records for one or more IOC IDs (GET /iocs/entities/indicators/v1). Requires the "IOC Management: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
indicatorIds | json | Yes | JSON array of CrowdStrike IOC IDs |
| Parameter | Type | Description |
|---|
indicators | array | CrowdStrike indicator of compromise records |
↳ id | string | Indicator identifier |
↳ type | string | Indicator type |
↳ value | string | Indicator value |
↳ action | string | Action taken when the indicator matches |
↳ mobileAction | string | Action taken on mobile platforms when the indicator matches |
↳ severity | string | Indicator severity |
↳ description | string | Indicator description |
↳ source | string | Indicator source |
↳ appliedGlobally | boolean | Whether the indicator applies to all hosts |
↳ platforms | array | Platforms the indicator applies to |
↳ hostGroups | array | Host group IDs the indicator is scoped to |
↳ tags | array | Tags applied to the indicator |
↳ expiration | string | Indicator expiration timestamp |
↳ expired | boolean | Whether the indicator has expired |
↳ deleted | boolean | Whether the indicator is deleted |
↳ fromParent | boolean | Whether the indicator was inherited from a parent CID |
↳ parentCidName | string | Parent CID name |
↳ createdBy | string | User who created the indicator |
↳ createdOn | string | Indicator creation timestamp |
↳ modifiedBy | string | User who last modified the indicator |
↳ modifiedOn | string | Indicator modification timestamp |
↳ metadata | json | File metadata CrowdStrike resolved for the indicator |
↳ avHits | number | Antivirus hit count |
↳ companyName | string | Company name |
↳ fileDescription | string | File description |
↳ fileVersion | string | File version |
↳ filename | string | File name |
↳ originalFilename | string | Original file name |
↳ productName | string | Product name |
↳ productVersion | string | Product version |
↳ signed | boolean | Whether the file is signed |
count | number | Number of indicators returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get the status and output of a Real Time Response command by cloud request ID (GET /real-time-response/entities/command/v1). Long output is chunked across sequences, so increment the sequence ID to read the next chunk. Requires the "Real time response: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
cloudRequestId | string | Yes | Cloud request ID returned by Execute RTR Command |
sequenceId | number | No | Output chunk to retrieve, starting at 0 |
| Parameter | Type | Description |
|---|
complete | boolean | Whether the command has finished running |
stdout | string | Standard output from the command |
stderr | string | Standard error from the command |
baseCommand | string | Base command that was run |
sessionId | string | RTR session the command ran in |
taskId | string | Task identifier for the command |
sequenceId | number | Output chunk sequence this response covers |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Aggregate CrowdStrike Identity Protection sensors from a JSON aggregate query body (POST /identity-protection/aggregates/devices/GET/v1). These are the domain controllers Falcon Identity Protection monitors, not Falcon endpoint sensors. Requires the "Identity Protection Entities: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
aggregateQuery | json | Yes | JSON aggregate query body documented by CrowdStrike for sensor aggregates |
| Parameter | Type | Description |
|---|
aggregates | array | Aggregate result groups returned by CrowdStrike |
↳ buckets | array | Buckets within the aggregate result |
↳ count | number | Bucket document count |
↳ from | number | Bucket lower bound |
↳ keyAsString | string | String representation of the bucket key |
↳ label | json | Bucket label object |
↳ stringFrom | string | String lower bound |
↳ stringTo | string | String upper bound |
↳ subAggregates | array | Nested aggregate results for this bucket |
↳ to | number | Bucket upper bound |
↳ value | number | Bucket metric value |
↳ valueAsString | string | String representation of the bucket value |
↳ docCountErrorUpperBound | number | Upper bound for bucket count error |
↳ name | string | Aggregate result name |
↳ sumOtherDocCount | number | Document count not included in the returned buckets |
count | number | Number of aggregate result groups returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get CrowdStrike Identity Protection sensor details for one or more device IDs (POST /identity-protection/entities/devices/GET/v1). These are the domain controllers Falcon Identity Protection monitors, not Falcon endpoint sensors. Requires the "Identity Protection Entities: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
ids | json | Yes | JSON array of CrowdStrike sensor device IDs |
| Parameter | Type | Description |
|---|
sensors | array | CrowdStrike identity sensor detail records |
↳ agentVersion | string | Sensor agent version |
↳ cid | string | CrowdStrike customer identifier |
↳ deviceId | string | Sensor device identifier |
↳ heartbeatTime | number | Last heartbeat timestamp |
↳ hostname | string | Sensor hostname |
↳ idpPolicyId | string | Assigned Identity Protection policy ID |
↳ idpPolicyName | string | Assigned Identity Protection policy name |
↳ ipAddress | string | Sensor local IP address |
↳ kerberosConfig | string | Kerberos configuration status |
↳ ldapConfig | string | LDAP configuration status |
↳ ldapsConfig | string | LDAPS configuration status |
↳ machineDomain | string | Machine domain |
↳ ntlmConfig | string | NTLM configuration status |
↳ osVersion | string | Operating system version |
↳ rdpToDcConfig | string | RDP to domain controller configuration status |
↳ smbToDcConfig | string | SMB to domain controller configuration status |
↳ status | string | Sensor protection status |
↳ statusCauses | array | Documented causes behind the current status |
↳ tiEnabled | string | Threat intelligence enablement status |
count | number | Number of sensors returned |
pagination | json | Pagination metadata (limit, offset, total) |
↳ limit | number | Page size used for the query |
↳ offset | number | Offset returned by CrowdStrike |
↳ total | number | Total records available |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Get CrowdStrike Falcon Spotlight vulnerability records for one or more vulnerability IDs, including CVE, affected host, application, and remediation details (GET /spotlight/entities/vulnerabilities/v2). Requires the spotlight-vulnerabilities:read API scope, shown as "Vulnerabilities: Read" in the Falcon API client UI.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
vulnerabilityIds | json | Yes | JSON array of Spotlight vulnerability IDs (maximum 400 per request) |
| Parameter | Type | Description |
|---|
vulnerabilities | array | CrowdStrike Spotlight vulnerability records |
↳ id | string | Vulnerability identifier |
↳ aid | string | Agent identifier of the affected host |
↳ cid | string | CrowdStrike customer identifier |
↳ status | string | Vulnerability status (open, closed, reopen) |
↳ confidence | string | Detection confidence |
↳ vulnerabilityId | string | Underlying vulnerability ID |
↳ createdTimestamp | string | Creation timestamp |
↳ updatedTimestamp | string | Last update timestamp |
↳ closedTimestamp | string | Closure timestamp |
↳ cve | json | CVE details for the vulnerability |
↳ id | string | CVE identifier |
↳ baseScore | number | CVSS base score |
↳ severity | string | CVE severity |
↳ exprtRating | string | CrowdStrike ExPRT rating |
↳ exploitStatus | number | Exploit status code |
↳ exploitabilityScore | number | CVSS exploitability score |
↳ impactScore | number | CVSS impact score |
↳ remediationLevel | string | CVSS remediation level |
↳ description | string | CVE description |
↳ publishedDate | string | CVE publication date |
↳ vector | string | CVSS vector string |
↳ types | array | CVE types |
↳ isCisaKev | boolean | Whether the CVE is in the CISA Known Exploited Vulnerabilities catalog |
↳ cisaDueDate | string | CISA remediation due date |
↳ app | json | Affected application |
↳ productNameNormalized | string | Normalized product name |
↳ productNameVersion | string | Product name and version |
↳ vendorNormalized | string | Normalized vendor name |
↳ hostInfo | json | Affected host details |
↳ hostname | string | Host name |
↳ localIp | string | Local IP address |
↳ machineDomain | string | Machine domain |
↳ osVersion | string | Operating system version |
↳ platform | string | Platform name |
↳ productTypeDesc | string | Product type description |
↳ assetCriticality | string | Asset criticality |
↳ internetExposure | string | Internet exposure |
↳ tags | array | Host tags |
↳ groups | array | Host group names the host belongs to |
↳ remediationIds | array | Remediation IDs for the vulnerability |
↳ remediations | array | Remediation entities for the vulnerability |
↳ id | string | Remediation identifier |
↳ title | string | Remediation title |
↳ action | string | Remediation action |
↳ type | string | Remediation type |
↳ link | string | Remediation link |
↳ reference | string | Remediation reference |
↳ vendorUrl | string | Vendor advisory URL |
↳ suppressionInfo | json | Suppression state for the vulnerability |
↳ isSuppressed | boolean | Whether the finding is suppressed |
↳ reason | string | Suppression reason |
count | number | Number of vulnerabilities returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Open a CrowdStrike Falcon Real Time Response session against a host so read-only commands can be run on it (POST /real-time-response/entities/sessions/v1). This connects a live remote shell to the endpoint. Requires the "Real time response: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
deviceId | string | Yes | CrowdStrike host agent ID (AID) to open the session against |
queueOffline | boolean | No | Queue the session so it runs when an offline host comes back online |
origin | string | No | Optional session origin string recorded by CrowdStrike |
| Parameter | Type | Description |
|---|
sessionId | string | RTR session ID to use for subsequent commands |
deviceId | string | Host agent ID for the session |
platform | string | Platform of the connected host |
pwd | string | Working directory the session started in |
offlineQueued | boolean | Whether the session was queued for an offline host |
existingAidSessions | number | Number of sessions already open against this host |
createdAt | string | Session creation timestamp |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Act on CrowdStrike Falcon hosts (POST /devices/entities/devices-actions/v2). Actions: contain, lift_containment, hide_host, unhide_host, detection_suppress, detection_unsuppress. contain network-isolates the host so it can only reach the Falcon cloud; hide_host removes the host record from the console. Both are immediately disruptive. Up to 100 host IDs per call. Requires the "Hosts: Write" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
actionName | string | Yes | Action to take: contain, lift_containment, hide_host, unhide_host, detection_suppress, or detection_unsuppress. "contain" network-isolates the host; "hide_host" removes it from the Falcon console. |
deviceIds | json | Yes | JSON array of up to 100 CrowdStrike host agent IDs (AIDs) to act on |
| Parameter | Type | Description |
|---|
affected | array | Entities affected by the action |
↳ id | string | Affected entity identifier |
↳ path | string | API path of the affected entity |
count | number | Number of hosts the action was applied to |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Add hosts to or remove hosts from a CrowdStrike Falcon static host group (POST /devices/entities/host-group-actions/v1). Group membership drives policy assignment, so changing it changes which policies apply to those hosts. Requires the "Host groups: Write" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
actionName | string | Yes | Action to take: add-hosts or remove-hosts |
hostGroupId | string | Yes | CrowdStrike host group ID to modify (static groups only) |
deviceIds | json | Yes | JSON array of CrowdStrike host agent IDs (AIDs) to add to or remove from the group |
| Parameter | Type | Description |
|---|
hostGroups | array | Host group records returned after the action |
↳ id | string | Host group identifier |
↳ name | string | Host group name |
↳ description | string | Host group description |
↳ groupType | string | Group type (static, dynamic, staticByID) |
↳ assignmentRule | string | FQL assignment rule for dynamic groups |
↳ createdBy | string | User who created the group |
↳ createdTimestamp | string | Group creation timestamp |
↳ modifiedBy | string | User who last modified the group |
↳ modifiedTimestamp | string | Group modification timestamp |
count | number | Number of host group records returned |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Search CrowdStrike Falcon alerts with a Falcon Query Language filter and return their composite IDs. Uses the current Alerts API (GET /alerts/queries/alerts/v2), which replaced the Detects API decommissioned on September 30, 2025. Requires the "Alerts: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
filter | string | No | Falcon Query Language filter over alert fields |
q | string | No | Free-text search across all alert metadata |
limit | number | No | Maximum number of alert IDs to return (max 10000) |
offset | number | No | Pagination offset for the alert query |
sort | string | No | Sort expression such as "created_timestamp|desc" |
includeHidden | boolean | No | Include previously hidden alerts (CrowdStrike defaults this to true) |
| Parameter | Type | Description |
|---|
alertIds | array | Composite alert IDs matching the query, ready for Get Alert Details |
count | number | Number of alert IDs returned |
pagination | json | Pagination metadata (limit, offset, total) |
↳ limit | number | Page size used for the query |
↳ offset | number | Offset returned by CrowdStrike |
↳ total | number | Total records available |
Search CrowdStrike Falcon Case Management cases with a Falcon Query Language filter and return their IDs (GET /cases/queries/cases/v1). Case Management supersedes the CrowdScore Incidents API, which CrowdStrike has removed from its published API spec. Requires the "Cases: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
filter | string | No | Falcon Query Language filter. Exact-match fields include cid and id; wildcard fields include assigned_to_name and assigned_to_uuid; range fields include created_timestamp and updated_timestamp. |
q | string | No | Free-text search across all case metadata |
limit | number | No | Maximum number of case IDs to return (max 10000, default 100) |
offset | number | No | Pagination offset for the case query |
sort | string | No | Sort expression such as "created_timestamp|desc" or "status|asc" |
| Parameter | Type | Description |
|---|
caseIds | array | Case IDs matching the query |
count | number | Number of case IDs returned |
pagination | json | Pagination metadata (limit, offset, total) |
↳ limit | number | Page size used for the query |
↳ offset | number | Offset returned by CrowdStrike |
↳ total | number | Total records available |
Search CrowdStrike Falcon host groups with a Falcon Query Language filter and return their IDs (GET /devices/queries/host-groups/v1). Requires the "Host groups: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
filter | string | No | Falcon Query Language filter over host group fields |
limit | number | No | Maximum number of host group IDs to return (1-5000) |
offset | number | No | Pagination offset for the host group query |
sort | string | No | Sort expression such as "name.asc" or "modified_timestamp.desc" |
| Parameter | Type | Description |
|---|
hostGroupIds | array | Host group IDs matching the query |
count | number | Number of host group IDs returned |
pagination | json | Pagination metadata (limit, offset, total) |
↳ limit | number | Page size used for the query |
↳ offset | number | Offset returned by CrowdStrike |
↳ total | number | Total records available |
Search custom CrowdStrike Falcon indicators of compromise (IOCs) with a Falcon Query Language filter and return their IDs (GET /iocs/queries/indicators/v1). Requires the "IOC Management: Read" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
filter | string | No | Falcon Query Language filter over IOC fields |
limit | number | No | Maximum number of IOC IDs to return (default 100). CrowdStrike publishes no maximum for this endpoint; Sim caps it at 500 to keep a single request bounded |
offset | number | No | Pagination offset. Mutually exclusive with the after cursor; use after beyond 10,000 IOCs. |
after | string | No | Pagination cursor from a previous response. Mutually exclusive with offset. |
sort | string | No | Sort expression. Supported fields include action, applied_globally, created_by, created_on, expiration, expired, modified_by, modified_on, severity_number, source, type, and value. |
| Parameter | Type | Description |
|---|
indicatorIds | array | IOC IDs matching the query |
count | number | Number of IOC IDs returned |
pagination | json | Pagination metadata (limit, offset, total, after) |
↳ limit | number | Page size used for the query |
↳ offset | number | Offset returned by CrowdStrike |
↳ total | number | Total records available |
↳ after | string | Cursor for the next page |
Search CrowdStrike Identity Protection sensors -- the domain controllers Falcon Identity Protection monitors, not Falcon endpoint sensors -- and return their device IDs (GET /identity-protection/queries/devices/v1). Sort uses the dot form, for example status.desc. Requires the "Identity Protection Entities: Read" API scope, a separate entitlement from Hosts and Alerts.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
filter | string | No | Falcon Query Language filter for identity sensor search |
limit | number | No | Maximum number of sensor records to return |
offset | number | No | Pagination offset for the identity sensor query |
sort | string | No | Sort expression for identity sensor results |
| Parameter | Type | Description |
|---|
sensors | array | Matching CrowdStrike identity sensor records |
↳ agentVersion | string | Sensor agent version |
↳ cid | string | CrowdStrike customer identifier |
↳ deviceId | string | Sensor device identifier |
↳ heartbeatTime | number | Last heartbeat timestamp |
↳ hostname | string | Sensor hostname |
↳ idpPolicyId | string | Assigned Identity Protection policy ID |
↳ idpPolicyName | string | Assigned Identity Protection policy name |
↳ ipAddress | string | Sensor local IP address |
↳ kerberosConfig | string | Kerberos configuration status |
↳ ldapConfig | string | LDAP configuration status |
↳ ldapsConfig | string | LDAPS configuration status |
↳ machineDomain | string | Machine domain |
↳ ntlmConfig | string | NTLM configuration status |
↳ osVersion | string | Operating system version |
↳ rdpToDcConfig | string | RDP to domain controller configuration status |
↳ smbToDcConfig | string | SMB to domain controller configuration status |
↳ status | string | Sensor protection status |
↳ statusCauses | array | Documented causes behind the current status |
↳ tiEnabled | string | Threat intelligence enablement status |
count | number | Number of sensors returned |
pagination | json | Pagination metadata (limit, offset, total) |
↳ limit | number | Page size used for the query |
↳ offset | number | Offset returned by CrowdStrike |
↳ total | number | Total records available |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Search CrowdStrike Falcon Spotlight vulnerabilities with a required Falcon Query Language filter and return their IDs (GET /spotlight/queries/vulnerabilities/v1). Requires the spotlight-vulnerabilities:read API scope, shown as "Vulnerabilities: Read" in the Falcon API client UI.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
filter | string | Yes | Falcon Query Language filter (required by Spotlight). Filterable fields include status, aid, cid, last_seen_within, cve.id, cve.severity, cve.exprt_rating, cve.is_cisa_kev, cve.base_score, host_info.platform_name, host_info.groups, host_info.tags, host_info.internet_exposure, and suppression_info.is_suppressed. |
limit | number | No | Maximum number of vulnerability IDs to return (1-400, default 100) |
after | string | No | Pagination cursor from a previous response. Spotlight does not support offset. |
sort | string | No | Sort expression such as "updated_timestamp|desc" or "closed_timestamp|asc" |
| Parameter | Type | Description |
|---|
vulnerabilityIds | array | Spotlight vulnerability IDs matching the query |
count | number | Number of vulnerability IDs returned |
pagination | json | Cursor pagination metadata (limit, total, after) |
↳ limit | number | Page size used for the query |
↳ total | number | Total records available |
↳ after | string | Cursor for the next page |
Update CrowdStrike Falcon alerts by composite ID: change status, assign or unassign an analyst, add or remove tags, append a comment, or toggle visibility (PATCH /alerts/entities/alerts/v3). This modifies live alerts in the Falcon console. Requires the "Alerts: Write" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
compositeIds | json | Yes | JSON array of CrowdStrike composite alert IDs to update |
updateStatus | string | No | New alert status: new, in_progress, reopened, or closed |
assignToUuid | string | No | Assign the alert to this Falcon user UUID |
assignToUserId | string | No | Assign the alert to this Falcon user ID, such as user@example.com |
assignToName | string | No | Assign the alert to this Falcon username, such as John Doe |
unassign | boolean | No | Clear the assigned user UUID, user ID, and username from the alert |
appendComment | string | No | Comment to append to the alert in the Falcon console |
addTag | string | No | Tag to add to the alert |
removeTag | string | No | Tag to remove from the alert |
removeTagsByPrefix | string | No | Remove every tag on the alert that starts with this prefix |
showInUi | boolean | No | Whether the alert is displayed in the Falcon console |
actionParameters | json | No | Raw JSON array of additional CrowdStrike action parameters, each shaped { "name": string, "value": string } |
includeHidden | boolean | No | Include previously hidden alerts (CrowdStrike defaults this to true) |
| Parameter | Type | Description |
|---|
updatedIds | array | Composite alert IDs the update was submitted for |
count | number | Number of alerts the update was submitted for |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |
Update custom CrowdStrike Falcon indicators of compromise by ID (PATCH /iocs/entities/indicators/v1). DESTRUCTIVE: omitted fields may be cleared, so read each indicator with crowdstrike_get_indicator_details first and resend its full field set with your edits applied. Changing action or scope changes prevention behavior fleet-wide. type and value are immutable. Requires the "IOC Management: Write" API scope.
| Parameter | Type | Required | Description |
|---|
clientId | string | Yes | CrowdStrike Falcon API client ID |
clientSecret | string | Yes | CrowdStrike Falcon API client secret |
cloud | string | Yes | CrowdStrike Falcon cloud region |
indicators | json | Yes | JSON array of indicators to update. Each entry requires id, and should also repeat every field it wants to keep: an updatable field the entry omits may be cleared. Updatable fields: action, severity, description, source, tags (array), platforms (array), applied_globally (boolean), host_groups (array), expiration (ISO 8601), mobile_action, metadata ({ filename }). type and value cannot be changed. |
comment | string | No | Audit comment explaining why these indicators were updated |
retrodetects | boolean | No | Whether to generate retroactive detections for the updated indicators |
ignoreWarnings | boolean | No | Whether to apply the updates even when CrowdStrike returns warnings |
| Parameter | Type | Description |
|---|
indicators | array | Updated CrowdStrike indicator records |
↳ id | string | Indicator identifier |
↳ type | string | Indicator type |
↳ value | string | Indicator value |
↳ action | string | Action taken when the indicator matches |
↳ mobileAction | string | Action taken on mobile platforms when the indicator matches |
↳ severity | string | Indicator severity |
↳ description | string | Indicator description |
↳ source | string | Indicator source |
↳ appliedGlobally | boolean | Whether the indicator applies to all hosts |
↳ platforms | array | Platforms the indicator applies to |
↳ hostGroups | array | Host group IDs the indicator is scoped to |
↳ tags | array | Tags applied to the indicator |
↳ expiration | string | Indicator expiration timestamp |
↳ expired | boolean | Whether the indicator has expired |
↳ deleted | boolean | Whether the indicator is deleted |
↳ fromParent | boolean | Whether the indicator was inherited from a parent CID |
↳ parentCidName | string | Parent CID name |
↳ createdBy | string | User who created the indicator |
↳ createdOn | string | Indicator creation timestamp |
↳ modifiedBy | string | User who last modified the indicator |
↳ modifiedOn | string | Indicator modification timestamp |
↳ metadata | json | File metadata CrowdStrike resolved for the indicator |
↳ avHits | number | Antivirus hit count |
↳ companyName | string | Company name |
↳ fileDescription | string | File description |
↳ fileVersion | string | File version |
↳ filename | string | File name |
↳ originalFilename | string | Original file name |
↳ productName | string | Product name |
↳ productVersion | string | Product version |
↳ signed | boolean | Whether the file is signed |
count | number | Number of indicators updated |
errors | array | Errors CrowdStrike returned alongside a partially successful response |
↳ code | number | CrowdStrike error code |
↳ id | string | Identifier the error applies to |
↳ message | string | Error message |