crowdstrike.falcon.alert_info module – Get information about Falcon alerts
Note
This module is part of the crowdstrike.falcon collection (version 4.15.0).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install crowdstrike.falcon.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: crowdstrike.falcon.alert_info.
New in crowdstrike.falcon 4.15.0
Synopsis
Returns details of Falcon alerts.
Gets alerts by composite ID, or searches for them with an FQL filter.
With no option, returns every alert.
The search reads all pages until there are no more matches, or until limit alerts are read.
Hidden alerts are returned too. Use the filter
show_in_ui:trueto leave them out.
Requirements
The below requirements are needed on the host that executes this module.
Alerts [READ] API scope
crowdstrike-falconpy >= 1.5.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
The registered result of the crowdstrike.falcon.auth module, or a dictionary containing the access_token and cloud keys. If provided, the client_id, client_secret, member_cid, and cloud options are ignored. Useful when needing to make multiple API calls to avoid rate limiting issues. |
|
The OAuth2 access token to use for authentication. |
|
The CrowdStrike cloud region to use. This can differ from the module’s cloud argument due to autodiscovery. |
|
The CrowdStrike API client ID to use. See the Falcon documentation for more information about API clients. The |
|
The CrowdStrike API secret that corresponds to the client ID. See the Falcon documentation for more information about API clients. The |
|
The CrowdStrike cloud region to use. All clouds are automatically discovered if not specified, except for the The Choices:
|
|
The composite IDs of the alerts to get, in the form The IDs are sent as given. An ID with a wrong CID or in upper case makes the API fail the whole request. The alerts are returned in the order of this list. A repeated ID returns one alert. An empty list returns no alerts. The module fails when an ID does not exist. Then the failed result has the alerts that were found in Mutually exclusive with filter, sort and limit. |
|
Extended headers that are prepended to the default headers dictionary. |
|
The FQL filter to search for alerts.
Join conditions with A filter on an unknown field returns no alerts, with no error. Mutually exclusive with composite_ids. |
|
The maximum number of alerts to return. When not set, the module returns every match. Must be 1 or greater. Mutually exclusive with composite_ids. |
|
The CrowdStrike member CID for MSSP authentication. See the Falcon documentation for more information about API clients. The |
|
The property and direction to sort the results by. With Mutually exclusive with composite_ids. Choices:
|
|
Custom User-Agent string to use for requests to the API. The user agent string is prepended to the default user agent string ( See RFC 7231 for more information. The |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full This action does not modify state. |
Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
|
Platforms: all |
Target OS/families that can be operated against |
See Also
See also
- crowdstrike.falcon.alert
Update Falcon alerts.
- Alerts API reference
The CrowdStrike API operations that this module uses.
Examples
- name: Get the closed endpoint alerts, newest first
crowdstrike.falcon.alert_info:
filter: "status:'closed'+product:'epp'"
sort: created_timestamp.desc
- name: Get the 10 newest alerts
crowdstrike.falcon.alert_info:
sort: created_timestamp.desc
limit: 10
- name: Get alerts by composite ID
crowdstrike.falcon.alert_info:
composite_ids:
- "1234567890abcdef1234567890abcdef:ind:abcdef1234567890abcdef1234567890:1234567890123456789-10304-123456789"
- name: Get all alerts except the hidden alerts
crowdstrike.falcon.alert_info:
filter: "show_in_ui:true"
- name: Get the open alerts of high severity
crowdstrike.falcon.alert_info:
filter: "status:!'closed'+severity:>=70"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The alerts that match the composite IDs or the filter. For composite IDs, in the order of composite_ids. An empty list when nothing matches. The keys below are common to most alerts. Other keys depend on the product of the alert. Returned: success |
|
The ID of the sensor that reported the alert. Returned: success Sample: |
|
The ID of the aggregate that the alert belongs to. Returned: success Sample: |
|
The name of the user that the alert is assigned to. Returned: when the alert is assigned Sample: |
|
The user name of the user that the alert is assigned to. Returned: when the alert is assigned Sample: |
|
The UUID of the user that the alert is assigned to. Returned: when the alert is assigned Sample: |
|
The customer ID that the alert belongs to. Returned: success Sample: |
|
The comments of the alert. Returned: when the alert has a comment |
|
The ID of the user who added the comment. Returned: success Sample: |
|
The time when the comment was added. Returned: success Sample: |
|
The text of the comment. Returned: success Sample: |
|
The composite ID of the alert. Returned: success Sample: |
|
The time when the alert was created. Returned: success Sample: |
|
The description of the alert. Returned: success Sample: |
|
The host that the alert is about. Returned: for endpoint alerts Sample: |
|
The display name of the alert. Returned: when the product sets it Sample: |
|
The ID of the alert, which is the composite ID without the leading customer ID. Returned: success Sample: |
|
The name of the alert. Returned: success Sample: |
|
The short name of the product that made the alert. Returned: success Sample: |
|
The resolution of the alert, for example Returned: when the alert is closed Sample: |
|
The number of seconds from the creation of the alert to its resolution. Returned: success Sample: |
|
The number of seconds from the creation of the alert to its triage. Returned: success Sample: |
|
The severity of the alert as a number. Returned: when the alert has a severity Sample: |
|
The name of the severity of the alert. Returned: when the alert has a severity Sample: |
|
Whether the alert is shown in the Falcon console. Returned: success Sample: |
|
The products that are the source of the alert. Returned: success Sample: |
|
The status of the alert. Returned: success Sample: |
|
The tags of the alert. Returned: when the alert has tags Sample: |
|
The time of the event that made the alert. Returned: success Sample: |
|
The type of the alert. Returned: success Sample: |
|
The time when the alert was last changed. Returned: success Sample: |