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

auth

dictionary

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.

access_token

string

The OAuth2 access token to use for authentication.

cloud

string

The CrowdStrike cloud region to use.

This can differ from the module’s cloud argument due to autodiscovery.

client_id

aliases: falcon_client_id

string

The CrowdStrike API client ID to use.

See the Falcon documentation for more information about API clients.

The FALCON_CLIENT_ID environment variable can also be used.

client_secret

aliases: falcon_client_secret

string

The CrowdStrike API secret that corresponds to the client ID.

See the Falcon documentation for more information about API clients.

The FALCON_CLIENT_SECRET environment variable can also be used.

cloud

string

The CrowdStrike cloud region to use.

All clouds are automatically discovered if not specified, except for the us-gov-1 cloud.

The FALCON_CLOUD environment variable can also be used.

Choices:

  • "us-1" ← (default)

  • "us-2"

  • "us-3"

  • "us-gov-1"

  • "us-gov-2"

  • "eu-1"

ext_headers

dictionary

Extended headers that are prepended to the default headers dictionary.

filter

string

The FQL filter to search for cases.

name:'Phishing investigation' is an exact, case-sensitive match of the name. A part of the name matches nothing.

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 name:*'Phishing*' with the part of the name before that character.

name:*'phishing*' matches the names that start with phishing.

status:'closed' matches the cases with a status.

tags:'malware' matches the cases with a tag.

Join conditions with + (AND).

Mutually exclusive with ids.

ids

list / elements=string

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.

limit

integer

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.

member_cid

string

The CrowdStrike member CID for MSSP authentication.

See the Falcon documentation for more information about API clients.

The FALCON_MEMBER_CID environment variable can also be used.

q

string

The free text to search for in the cases.

Mutually exclusive with ids.

sort

string

The property and direction to sort the results by, for example created_timestamp.desc or name.asc.

Mutually exclusive with ids.

user_agent

string

Custom User-Agent string to use for requests to the API.

The user agent string is prepended to the default user agent string (crowdstrike-ansible/<version>).

See RFC 7231 for more information.

The FALCON_USER_AGENT environment variable can also be used.

Attributes

Attribute

Support

Description

check_mode

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.

diff_mode

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

platform

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

cases

list / elements=dictionary

The cases that match the IDs, the filter or the search.

An empty list when nothing matches.

Returned: success

analysis_results

dictionary

The analysis results of the case, by type.

Each type has a list of records.

Returned: success

assigned_to

dictionary

The user that the case is assigned to.

Returned: success

email

string

The email address of the user.

Returned: success

Sample: "analyst@example.com"

full_name

string

The full name of the user.

Returned: success

Sample: "Example Analyst"

uuid

string

The UUID of the user.

Returned: success

Sample: "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"

assigned_to_groups

list / elements=dictionary

The user groups that the case is assigned to.

Returned: success

cid

string

The customer ID that the case belongs to.

Returned: success

Sample: "0123456789abcdef0123456789abcdef"

consistency

dictionary

The consistency data of the case.

Returned: success

consistent

boolean

Whether the case data is consistent.

Returned: success

Sample: true

version

integer

The consistency version of the case.

Returned: success

Sample: 3

created_by

dictionary

The user that created the case.

Returned: success

email

string

The email address of the user.

Returned: success

Sample: "analyst@example.com"

full_name

string

The full name of the user.

Returned: success

Sample: "Example Analyst"

uuid

string

The UUID of the user.

Returned: success

Sample: "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"

created_timestamp

string

The time when the case was created.

Returned: success

Sample: "2026-11-18T21:43:48Z"

creation_actor

dictionary

The actor that created the case.

Returned: success

type

string

The type of the actor.

Returned: success

Sample: "user"

description

string

The description of the case.

Returned: success

Sample: "Investigate the phishing alerts of the finance team"

end_timestamp

string

The time when the case was closed.

Returned: success

Sample: "2026-11-18T22:05:00Z"

evidence

dictionary

The evidence of the case, by type.

Each type has a list of records.

Returned: success

id

string

The ID of the case.

Returned: success

Sample: "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d"

last_updated_by

dictionary

The user that last updated the case.

Returned: success

email

string

The email address of the user.

Returned: success

Sample: "analyst@example.com"

full_name

string

The full name of the user.

Returned: success

Sample: "Example Analyst"

uuid

string

The UUID of the user.

Returned: success

Sample: "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d"

name

string

The name of the case.

Returned: success

Sample: "Phishing investigation"

read_only

dictionary

The read-only state of the case.

Returned: success

is_read_only

boolean

Whether the case is read only.

Returned: success

Sample: false

reference_id

string

The reference ID of the case.

Returned: success

Sample: "CASE-123"

severity

integer

The severity of the case.

Returned: success

Sample: 50

severity_info

dictionary

The severity details of the case.

Returned: success

level

string

The severity level of the case.

Returned: success

Sample: "Medium"

start_timestamp

string

The start time of the case.

Returned: success

status

string

The status of the case.

Returned: success

Sample: "closed"

tags

list / elements=string

The tags of the case.

Returned: success

Sample: ["malware"]

update_actor

dictionary

The actor that last updated the case.

Returned: success

type

string

The type of the actor.

Returned: success

Sample: "user"

updated_timestamp

string

The time when the case was last updated.

Returned: success

Sample: "2026-11-18T21:50:12Z"

version

integer

The version of the case.

Returned: success

Sample: 3

Authors

  • Carlos Matos (@carlosmmatos)