crowdstrike.falcon.case_info module – Get information about Falcon cases
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.case_info.
New in crowdstrike.falcon 4.15.0
Synopsis
Returns details of Falcon cases.
Gets cases by ID, or searches for them with an FQL filter or a free text search.
With no option, returns every case.
Requirements
The below requirements are needed on the host that executes this module.
Cases [READ] API scope
CrowdStrike FalconPy >= 1.5.5
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:
|
|
Extended headers that are prepended to the default headers dictionary. |
|
The FQL filter to search for cases.
An exact name filter does not find a name with a single quote or a backslash, also when they are escaped. Use a prefix filter such as
Join conditions with Mutually exclusive with ids. |
|
The IDs of the cases to get. An ID that does not exist is left out of the result. An empty list returns no cases. The cases are returned in the order of the IDs. Mutually exclusive with filter, q, sort and limit. |
|
The maximum number of cases to return. With no limit, the module returns every case that matches. Must be 1 or greater. Mutually exclusive with ids. |
|
The CrowdStrike member CID for MSSP authentication. See the Falcon documentation for more information about API clients. The |
|
The free text to search for in the cases. Mutually exclusive with ids. |
|
The property and direction to sort the results by, for example Mutually exclusive with ids. |
|
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.host_contain
Contain or lift containment on Falcon hosts.
- Case Management API reference
The CrowdStrike API operations that this module uses.
Examples
- name: Get all cases
crowdstrike.falcon.case_info:
- name: Get cases by ID
crowdstrike.falcon.case_info:
ids:
- "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d"
- name: Get the case with an exact name (case sensitive)
crowdstrike.falcon.case_info:
filter: "name:'Phishing investigation'"
- name: Get the cases whose name starts with phishing, newest first
crowdstrike.falcon.case_info:
filter: "name:*'phishing*'"
sort: created_timestamp.desc
- name: Get the 10 first closed cases, sorted by name
crowdstrike.falcon.case_info:
filter: "status:'closed'"
sort: name.asc
limit: 10
- name: Get the cases with a tag
crowdstrike.falcon.case_info:
filter: "tags:'malware'"
- name: Search the cases for a text
crowdstrike.falcon.case_info:
q: phishing
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The cases that match the IDs, the filter or the search. An empty list when nothing matches. Returned: success |
|
The analysis results of the case, by type. Each type has a list of Returned: success |
|
The user that the case is assigned to. Returned: success |
|
The email address of the user. Returned: success Sample: |
|
The full name of the user. Returned: success Sample: |
|
The UUID of the user. Returned: success Sample: |
|
The user groups that the case is assigned to. Returned: success |
|
The customer ID that the case belongs to. Returned: success Sample: |
|
The consistency data of the case. Returned: success |
|
Whether the case data is consistent. Returned: success Sample: |
|
The consistency version of the case. Returned: success Sample: |
|
The user that created the case. Returned: success |
|
The email address of the user. Returned: success Sample: |
|
The full name of the user. Returned: success Sample: |
|
The UUID of the user. Returned: success Sample: |
|
The time when the case was created. Returned: success Sample: |
|
The actor that created the case. Returned: success |
|
The type of the actor. Returned: success Sample: |
|
The description of the case. Returned: success Sample: |
|
The time when the case was closed. Returned: success Sample: |
|
The evidence of the case, by type. Each type has a list of Returned: success |
|
The ID of the case. Returned: success Sample: |
|
The user that last updated the case. Returned: success |
|
The email address of the user. Returned: success Sample: |
|
The full name of the user. Returned: success Sample: |
|
The UUID of the user. Returned: success Sample: |
|
The name of the case. Returned: success Sample: |
|
The read-only state of the case. Returned: success |
|
Whether the case is read only. Returned: success Sample: |
|
The reference ID of the case. Returned: success Sample: |
|
The severity of the case. Returned: success Sample: |
|
The severity details of the case. Returned: success |
|
The severity level of the case. Returned: success Sample: |
|
The start time of the case. Returned: success |
|
The status of the case. Returned: success Sample: |
|
The tags of the case. Returned: success Sample: |
|
The actor that last updated the case. Returned: success |
|
The type of the actor. Returned: success Sample: |
|
The time when the case was last updated. Returned: success Sample: |
|
The version of the case. Returned: success Sample: |