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:true to 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

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"

composite_ids

list / elements=string

The composite IDs of the alerts to get, in the form <cid>:<product>:<...>. This is the composite_id key of an alert, not its id key.

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 alerts, and the API errors.

Mutually exclusive with filter, sort and limit.

ext_headers

dictionary

Extended headers that are prepended to the default headers dictionary.

filter

string

The FQL filter to search for alerts.

status:'closed' matches alerts with that status exactly.

status:!'new' matches alerts that do not have that status.

product:'epp' matches the alerts of one product exactly.

severity:>=50 matches alerts with a severity of 50 or more.

created_timestamp:>'2026-11-01T00:00:00Z' matches alerts created after that time.

tags:'false_positive' matches alerts that have that tag.

resolution:'false_positive' matches closed alerts with that resolution.

assigned_to_name:*'name*' matches alerts whose assignee name starts with the text.

composite_id:'<id>' matches the alert with that composite ID.

show_in_ui:false matches hidden alerts, and show_in_ui:true leaves them out.

Join conditions with + (AND), for example status:!'closed'+severity:>=70.

A filter on an unknown field returns no alerts, with no error.

Mutually exclusive with composite_ids.

limit

integer

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.

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.

sort

string

The property and direction to sort the results by.

With severity, alerts that have no severity come last in both directions.

Mutually exclusive with composite_ids.

Choices:

  • "created_timestamp.asc"

  • "created_timestamp.desc"

  • "updated_timestamp.asc"

  • "updated_timestamp.desc"

  • "timestamp.asc"

  • "timestamp.desc"

  • "severity.asc"

  • "severity.desc"

  • "status.asc"

  • "status.desc"

  • "composite_id.asc"

  • "composite_id.desc"

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.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

alerts

list / elements=dictionary

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

agent_id

string

The ID of the sensor that reported the alert.

Returned: success

Sample: "abcdef1234567890abcdef1234567890"

aggregate_id

string

The ID of the aggregate that the alert belongs to.

Returned: success

Sample: "aggind:abcdef1234567890abcdef1234567890:123456789012"

assigned_to_name

string

The name of the user that the alert is assigned to.

Returned: when the alert is assigned

Sample: "Example User"

assigned_to_uid

string

The user name of the user that the alert is assigned to.

Returned: when the alert is assigned

Sample: "user@example.com"

assigned_to_uuid

string

The UUID of the user that the alert is assigned to.

Returned: when the alert is assigned

Sample: "12345678-90ab-cdef-1234-567890abcdef"

cid

string

The customer ID that the alert belongs to.

Returned: success

Sample: "1234567890abcdef1234567890abcdef"

comments

list / elements=dictionary

The comments of the alert.

Returned: when the alert has a comment

falcon_user_id

string

The ID of the user who added the comment.

Returned: success

Sample: "12345678-90ab-cdef-1234-567890abcdef"

timestamp

string

The time when the comment was added.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

value

string

The text of the comment.

Returned: success

Sample: "Example comment"

composite_id

string

The composite ID of the alert.

Returned: success

Sample: "1234567890abcdef1234567890abcdef:ind:abcdef1234567890abcdef1234567890:1234567890123456789-10304-123456789"

created_timestamp

string

The time when the alert was created.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

description

string

The description of the alert.

Returned: success

Sample: "Example alert description"

device

dictionary

The host that the alert is about.

Returned: for endpoint alerts

Sample: {"device_id": "abcdef1234567890abcdef1234567890", "hostname": "example-host"}

display_name

string

The display name of the alert.

Returned: when the product sets it

Sample: "Example detection"

id

string

The ID of the alert, which is the composite ID without the leading customer ID.

Returned: success

Sample: "ind:abcdef1234567890abcdef1234567890:1234567890123456789-10304-123456789"

name

string

The name of the alert.

Returned: success

Sample: "ExampleDetection"

product

string

The short name of the product that made the alert.

Returned: success

Sample: "epp"

resolution

string

The resolution of the alert, for example false_positive or ignored.

Returned: when the alert is closed

Sample: "false_positive"

seconds_to_resolved

integer

The number of seconds from the creation of the alert to its resolution.

Returned: success

Sample: 0

seconds_to_triaged

integer

The number of seconds from the creation of the alert to its triage.

Returned: success

Sample: 0

severity

integer

The severity of the alert as a number.

Returned: when the alert has a severity

Sample: 70

severity_name

string

The name of the severity of the alert.

Returned: when the alert has a severity

Sample: "High"

show_in_ui

boolean

Whether the alert is shown in the Falcon console. false for a hidden alert.

Returned: success

Sample: true

source_products

list / elements=string

The products that are the source of the alert.

Returned: success

Sample: ["Falcon Insight"]

status

string

The status of the alert.

Returned: success

Sample: "new"

tags

list / elements=string

The tags of the alert.

Returned: when the alert has tags

Sample: ["false_positive"]

timestamp

string

The time of the event that made the alert.

Returned: success

Sample: "2026-01-01T00:00:00.000Z"

type

string

The type of the alert.

Returned: success

Sample: "ldt"

updated_timestamp

string

The time when the alert was last changed.

Returned: success

Sample: "2026-01-01T00:00:00.000000000Z"

Authors

  • Carlos Matos (@carlosmmatos)