Skip to content
Joshua Hiller edited this page May 31, 2024 · 16 revisions

CrowdStrike Falcon CrowdStrike Subreddit

Using the Alerts service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation ID Description
PostAggregatesAlertsV1
PEP 8 get_aggregate_alerts_v1
Retrieve aggregates for alerts across all CIDs.
PostAggregatesAlertsV2
PEP 8 get_aggregate_alerts_v2
Retrieve aggregates for alerts across all CIDs.
PatchEntitiesAlertsV2
PEP 8 update_alerts_v2
Perform actions on alerts identified by alert ID(s) in request.
PatchEntitiesAlertsV3
PEP 8 update_alerts_v3
Perform actions on alerts identified by alert ID(s) in request.
PostEntitiesAlertsV1
PEP 8 get_alerts_v1
Retrieve all alerts given their IDs.
PostEntitiesAlertsV2
PEP 8 get_alerts_v2
Retrieve all alerts given their IDs.
GetQueriesAlertsV1
PEP 8 query_alerts_v1
Search for alert IDs that match a given query.
GetQueriesAlertsV2
PEP 8 query_alerts_v2
Search for alert IDs that match a given query.

Passing credentials

WARNING

client_id and client_secret are keyword arguments that contain your CrowdStrike API credentials. Please note that all examples below do not hard code these values. (These values are ingested as strings.)

CrowdStrike does not recommend hard coding API credentials or customer identifiers within source code.

PostAggregatesAlertsV1

Get alert aggregates as specified via json in request body.

PEP8 method name

get_aggregate_alerts_v1 (or get_aggregate_alerts)

Endpoint

Method Route
POST /alerts/aggregates/alerts/v1

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body list of dictionaries Full body payload in JSON format.
date_ranges
Service Class Support

No Uber Class Support
body list of dictionaries Applies to date_range aggregations.

Example:
[
  {
    "from": "2016-05-28T09:00:31Z",
    "to": "2016-05-30T09:00:31Z"
  },
  {
    "from": "2016-06-01T09:00:31Z",
    "to": "2016-06-10T09:00:31Z"
  }
]
exclude
Service Class Support

No Uber Class Support
body string Elements to exclude.
field
Service Class Support

No Uber Class Support
body string The field on which to compute the aggregation.
filter
Service Class Support

No Uber Class Support
body string FQL syntax formatted string to use to filter the results.
from
Service Class Support

No Uber Class Support
body integer Starting position.
include
Service Class Support

No Uber Class Support
body string Elements to include.
interval
Service Class Support

No Uber Class Support
body string Time interval for date histogram aggregations. Valid values include:
  • year
  • month
  • week
  • day
  • hour
  • minute
max_doc_count
Service Class Support

No Uber Class Support
body integer Only return buckets if values are less than or equal to the value here.
min_doc_count
Service Class Support

No Uber Class Support
body integer Only return buckets if values are greater than or equal to the value here.
missing
Service Class Support

No Uber Class Support
body string Missing is the value to be used when the aggregation field is missing from the object. In other words, the missing parameter defines how documents that are missing a value should be treated. By default they will be ignored, but it is also possible to treat them as if they had a value.
name
Service Class Support

No Uber Class Support
body string Name of the aggregate query, as chosen by the user. Used to identify the results returned to you.
q
Service Class Support

No Uber Class Support
body string Full text search across all metadata fields.
ranges
Service Class Support

No Uber Class Support
body list of dictionaries Applies to range aggregations. Ranges values will depend on field.

For example, if max_severity is used, ranges might look like:
[
  {
    "From": 0,
    "To": 70
  },
  {
    "From": 70,
    "To": 100
  }
]
size
Service Class Support

No Uber Class Support
body integer The max number of term buckets to be returned.
sub_aggregates
Service Class Support

No Uber Class Support
body list of dictionaries A nested aggregation, such as:
[
  {
    "name": "max_first_behavior",
    "type": "max",
    "field": "first_behavior"
  }
]

There is a maximum of 3 nested aggregations per request.
sort
Service Class Support

No Uber Class Support
body string FQL syntax string to sort bucket results.
  • _count - sort by document count
  • _term - sort by the string value alphabetically
Supports asc and desc using | format.

Example: _count|desc
time_zone
Service Class Support

No Uber Class Support
body string Time zone for bucket results.
type
Service Class Support

No Uber Class Support
body string Type of aggregation. Valid values include:
  • date_histogram - Aggregates counts on a specified time interval. Requires use of “interval” field.
  • date_range - Aggregates counts on custom defined date range buckets. Can include multiple ranges. (Similar to time series, but the bucket sizes are variable). Date formats to follow ISO 8601.
  • terms - Buckets alerts by the value of a specified field. For example, if field used is scenario, then alerts will be bucketed by the various alert scenario names.
  • range - Buckets alerts by specified (numeric) ranges of a specified field. For example, if doing a range aggregation on the max_severity field, the alerts will be counted by the specified ranges of severity.
  • cardinality - Returns the count of distinct values in a specified field.
  • max - Returns the maximum value of a specified field.
  • min - Returns the minimum value of a specified field.
  • avg - Returns the average value of the specified field.
  • sum - Returns the total sum of all values for the specified field.
  • percentiles - Returns the following percentiles for the specified field: 1, 5, 25, 50, 75, 95, 99.

Usage

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

date_range = {
    "from": "string",
    "to": "string"
}
search_range = {
    "From": integer,
    "To": integer
}

response = falcon.get_aggregate_alerts_v1(date_ranges=[date_range],
                                          exclude="string",
                                          field="string",
                                          filter="string",
                                          from=integer,
                                          include="string",
                                          interval="string",
                                          max_doc_count=integer,
                                          min_doc_count=integer,
                                          missing="string",
                                          name="string",
                                          q="string",
                                          ranges=[search_range],
                                          size=integer,
                                          sort="string",
                                          time_zone="string",
                                          type="string"
                                          )
print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

date_range = {
    "from": "string",
    "to": "string"
}
search_range = {
    "From": integer,
    "To": integer
}

response = falcon.PostAggregatesAlertsV1(date_ranges=[date_range],
                                         exclude="string",
                                         field="string",
                                         filter="string",
                                         from=integer,
                                         include="string",
                                         interval="string",
                                         max_doc_count=integer,
                                         min_doc_count=integer,
                                         missing="string",
                                         name="string",
                                         q="string",
                                         ranges=[search_range],
                                         size=integer,
                                         sort="string",
                                         time_zone="string",
                                         type="string"
                                         )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

BODY = [{
    "date_ranges": [
        {
            "from": "string",
            "to": "string"
        }
    ],
    "exclude": "string",
    "field": "string",
    "filter": "string",
    "from": integer,
    "include": "string",
    "interval": "string",
    "max_doc_count": integer,
    "min_doc_count": integer,
    "missing": "string",
    "name": "string",
    "q": "string",
    "ranges": [
        {
            "From": integer,
            "To": integer
        }
    ],
    "size": integer,
    "sort": "string",
    "sub_aggregates": [
        null
    ]
    "time_zone": "string",
    "type": "string"
}]

response = falcon.command("PostAggregatesAlertsV1", body=BODY)

print(response)

PostAggregatesAlertsV2

Get alert aggregates as specified via json in request body.

PEP8 method name

get_aggregate_alerts_v2

Endpoint

Method Route
POST /alerts/aggregates/alerts/v2

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body list of dictionaries Full body payload in JSON format.
date_ranges
Service Class Support

No Uber Class Support
body list of dictionaries Applies to date_range aggregations.

Example:
[
  {
    "from": "2016-05-28T09:00:31Z",
    "to": "2016-05-30T09:00:31Z"
  },
  {
    "from": "2016-06-01T09:00:31Z",
    "to": "2016-06-10T09:00:31Z"
  }
]
exclude
Service Class Support

No Uber Class Support
body string Elements to exclude.
field
Service Class Support

No Uber Class Support
body string The field on which to compute the aggregation.
filter
Service Class Support

No Uber Class Support
body string FQL syntax formatted string to use to filter the results.
from
Service Class Support

No Uber Class Support
body integer Starting position.
include
Service Class Support

No Uber Class Support
body string Elements to include.
include_hidden
Service Class Support

Uber Class Support
query string Allows previously hidden alerts to be retrieved.
interval
Service Class Support

No Uber Class Support
body string Time interval for date histogram aggregations. Valid values include:
  • year
  • month
  • week
  • day
  • hour
  • minute
max_doc_count
Service Class Support

No Uber Class Support
body integer Only return buckets if values are less than or equal to the value here.
min_doc_count
Service Class Support

No Uber Class Support
body integer Only return buckets if values are greater than or equal to the value here.
missing
Service Class Support

No Uber Class Support
body string Missing is the value to be used when the aggregation field is missing from the object. In other words, the missing parameter defines how documents that are missing a value should be treated. By default they will be ignored, but it is also possible to treat them as if they had a value.
name
Service Class Support

No Uber Class Support
body string Name of the aggregate query, as chosen by the user. Used to identify the results returned to you.
q
Service Class Support

No Uber Class Support
body string Full text search across all metadata fields.
ranges
Service Class Support

No Uber Class Support
body list of dictionaries Applies to range aggregations. Ranges values will depend on field.

For example, if max_severity is used, ranges might look like:
[
  {
    "From": 0,
    "To": 70
  },
  {
    "From": 70,
    "To": 100
  }
]
size
Service Class Support

No Uber Class Support
body integer The max number of term buckets to be returned.
sub_aggregates
Service Class Support

No Uber Class Support
body list of dictionaries A nested aggregation, such as:
[
  {
    "name": "max_first_behavior",
    "type": "max",
    "field": "first_behavior"
  }
]

There is a maximum of 3 nested aggregations per request.
sort
Service Class Support

No Uber Class Support
body string FQL syntax string to sort bucket results.
  • _count - sort by document count
  • _term - sort by the string value alphabetically
Supports asc and desc using | format.

Example: _count|desc
time_zone
Service Class Support

No Uber Class Support
body string Time zone for bucket results.
type
Service Class Support

No Uber Class Support
body string Type of aggregation. Valid values include:
  • date_histogram - Aggregates counts on a specified time interval. Requires use of “interval” field.
  • date_range - Aggregates counts on custom defined date range buckets. Can include multiple ranges. (Similar to time series, but the bucket sizes are variable). Date formats to follow ISO 8601.
  • terms - Buckets alerts by the value of a specified field. For example, if field used is scenario, then alerts will be bucketed by the various alert scenario names.
  • range - Buckets alerts by specified (numeric) ranges of a specified field. For example, if doing a range aggregation on the max_severity field, the alerts will be counted by the specified ranges of severity.
  • cardinality - Returns the count of distinct values in a specified field.
  • max - Returns the maximum value of a specified field.
  • min - Returns the minimum value of a specified field.
  • avg - Returns the average value of the specified field.
  • sum - Returns the total sum of all values for the specified field.
  • percentiles - Returns the following percentiles for the specified field: 1, 5, 25, 50, 75, 95, 99.

Usage

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

date_range = {
    "from": "string",
    "to": "string"
}
search_range = {
    "From": integer,
    "To": integer
}

response = falcon.get_aggregate_alerts_v2(date_ranges=[date_range],
                                          exclude="string",
                                          field="string",
                                          filter="string",
                                          from=integer,
                                          include="string",
                                          include_hidden=boolean,
                                          interval="string",
                                          max_doc_count=integer,
                                          min_doc_count=integer,
                                          missing="string",
                                          name="string",
                                          q="string",
                                          ranges=[search_range],
                                          size=integer,
                                          sort="string",
                                          time_zone="string",
                                          type="string"
                                          )
print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

date_range = {
    "from": "string",
    "to": "string"
}
search_range = {
    "From": integer,
    "To": integer
}

response = falcon.PostAggregatesAlertsV2(date_ranges=[date_range],
                                         exclude="string",
                                         field="string",
                                         filter="string",
                                         from=integer,
                                         include="string",
                                         include_hidden=boolean,
                                         interval="string",
                                         max_doc_count=integer,
                                         min_doc_count=integer,
                                         missing="string",
                                         name="string",
                                         q="string",
                                         ranges=[search_range],
                                         size=integer,
                                         sort="string",
                                         time_zone="string",
                                         type="string"
                                         )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

BODY = [{
    "date_ranges": [
        {
            "from": "string",
            "to": "string"
        }
    ],
    "exclude": "string",
    "field": "string",
    "filter": "string",
    "from": integer,
    "include": "string",
    "interval": "string",
    "max_doc_count": integer,
    "min_doc_count": integer,
    "missing": "string",
    "name": "string",
    "q": "string",
    "ranges": [
        {
            "From": integer,
            "To": integer
        }
    ],
    "size": integer,
    "sort": "string",
    "sub_aggregates": [
        null
    ]
    "time_zone": "string",
    "type": "string"
}]

response = falcon.command("PostAggregatesAlertsV2", body=BODY, include_hidden=boolean)

print(response)

PatchEntitiesAlertsV2

Perform actions on alerts identified by alert ID(s) in request.

PEP8 method name

update_alerts_v2 (or update_alerts)

Endpoint

Method Route
PATCH /alerts/entities/alerts/v2

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
action_parameters
Service Class Support

Uber Class Support
body list of dictionaries List of dictionaries containing action specific parameter settings.
add_tag
Service Class Support

Uber Class Support
body
action_parameters
string Add a tag to 1 or more alert(s).
append_comment
Service Class Support

Uber Class Support
body
action_parameters
string Appends new comment to existing comments.
assign_to_name
Service Class Support

Uber Class Support
body
action_parameters
string Assign 1 or more alert(s) to a user identified by user name.
assign_to_user_id
Service Class Support

Uber Class Support
body
action_parameters
string Assign 1 or more alert(s) to a user identified by user id (eg: [email protected]).
assign_to_uuid
Service Class Support

Uber Class Support
body
action_parameters
string A user ID (Ex: [email protected]) to assign the alert to.
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
ids
Service Class Support

Uber Class Support
body string or list of strings ID(s) of the alerts to update, which you can find with theGetQueriesAlertsV1 operation.
new_behavior_processed
Service Class Support

Uber Class Support
body
action_parameters
string Adds a newly processed behavior to 1 or more alert(s).
remove_tag
Service Class Support

Uber Class Support
body
action_parameters
string Remove a tag from 1 or more alert(s).
remove_tag_by_prefix
Service Class Support

Uber Class Support
body
action_parameters
string Remove tags with given prefix from 1 or more alert(s).
show_in_ui
Service Class Support

Uber Class Support
body
action_parameters
boolean Boolean determining if this alert is displayed in the Falcon console.
  • true: This alert is displayed in Falcon
  • false: This alert is not displayed in Falcon.
unassign
Service Class Support

Uber Class Support
body
action_parameters
string Unassign an previously assigned user from 1 or more alert(s). The value passed to this action is ignored.
update_status
Service Class Support

Uber Class Support
body
action_parameters
string Update status of the alert.

Allowed values:
  • ignored
  • new
  • in_progress
  • true_positive
  • false_positive

Usage

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.update_alerts_v2(add_tag="string",
                                   append_comment="string",
                                   assign_to_name="string",
                                   assign_to_user_id="string",
                                   assign_to_uuid="string",
                                   ids=id_list,
                                   new_behavior_processed="string",
                                   remove_tag="string",
                                   remove_tags_by_prefix="string",
                                   show_in_ui=boolean,
                                   unassign="string",
                                   update_status="string"
                                   )
print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.PatchEntitiesAlertsV2(add_tag="string",
                                        append_comment="string",
                                        assign_to_name="string",
                                        assign_to_user_id="string",
                                        assign_to_uuid="string",
                                        ids=id_list,
                                        new_behavior_processed="string",
                                        remove_tag="string",
                                        remove_tags_by_prefix="string",
                                        show_in_ui=boolean,
                                        unassign="string",
                                        update_status="string"
                                        )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = ['ID1', 'ID2', 'ID3']

BODY = {
    "ids": id_list,
    "request": {
        "action_parameters": [
            {
                "name": "string",
                "value": "string"
            }
        ]
    }
}

response = falcon.command("PatchEntitiesAlertsV2", body=BODY)

print(response)

PatchEntitiesAlertsV3

Perform actions on alerts identified by alert ID(s) in request.

PEP8 method name

update_alerts_v3

Endpoint

Method Route
PATCH /alerts/entities/alerts/v3

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
action_parameters
Service Class Support

Uber Class Support
body list of dictionaries List of dictionaries containing action specific parameter settings.
add_tag
Service Class Support

Uber Class Support
body
action_parameters
string Add a tag to 1 or more alert(s).
append_comment
Service Class Support

Uber Class Support
body
action_parameters
string Appends new comment to existing comments.
assign_to_name
Service Class Support

Uber Class Support
body
action_parameters
string Assign 1 or more alert(s) to a user identified by user name.
assign_to_user_id
Service Class Support

Uber Class Support
body
action_parameters
string Assign 1 or more alert(s) to a user identified by user id (eg: [email protected]).
assign_to_uuid
Service Class Support

Uber Class Support
body
action_parameters
string A user ID (Ex: [email protected]) to assign the alert to.
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
composite_ids
Service Class Support

Uber Class Support
body string or list of strings Composite ID(s) of the alerts to update, which you can find with theGetQueriesAlertsV1 operation.
include_hidden
Service Class Support

Uber Class Support
query string Allows previously hidden alerts to be retrieved.
new_behavior_processed
Service Class Support

Uber Class Support
body
action_parameters
string Adds a newly processed behavior to 1 or more alert(s).
remove_tag
Service Class Support

Uber Class Support
body
action_parameters
string Remove a tag from 1 or more alert(s).
remove_tag_by_prefix
Service Class Support

Uber Class Support
body
action_parameters
string Remove tags with given prefix from 1 or more alert(s).
show_in_ui
Service Class Support

Uber Class Support
body
action_parameters
boolean Boolean determining if this alert is displayed in the Falcon console.
  • true: This alert is displayed in Falcon
  • false: This alert is not displayed in Falcon.
unassign
Service Class Support

Uber Class Support
body
action_parameters
string Unassign an previously assigned user from 1 or more alert(s). The value passed to this action is ignored.
update_status
Service Class Support

Uber Class Support
body
action_parameters
string Update status of the alert.

Allowed values:
  • ignored
  • new
  • in_progress
  • true_positive
  • false_positive

Usage

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.update_alerts_v3(add_tag="string",
                                   append_comment="string",
                                   assign_to_name="string",
                                   assign_to_user_id="string",
                                   assign_to_uuid="string",
                                   composite_ids=id_list,
                                   include_hidden=boolean,
                                   new_behavior_processed="string",
                                   remove_tag="string",
                                   remove_tags_by_prefix="string",
                                   show_in_ui=boolean,
                                   unassign="string",
                                   update_status="string"
                                   )
print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.PatchEntitiesAlertsV3(add_tag="string",
                                        append_comment="string",
                                        assign_to_name="string",
                                        assign_to_user_id="string",
                                        assign_to_uuid="string",
                                        composite_ids=id_list,
                                        include_hidden=boolean,
                                        new_behavior_processed="string",
                                        remove_tag="string",
                                        remove_tags_by_prefix="string",
                                        show_in_ui=boolean,
                                        unassign="string",
                                        update_status="string"
                                        )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = ['ID1', 'ID2', 'ID3']

BODY = {
    "composite_ids": id_list,
    "request": {
        "action_parameters": [
            {
                "name": "string",
                "value": "string"
            }
        ]
    }
}

response = falcon.command("PatchEntitiesAlertsV3", body=BODY, include_hidden=boolean)

print(response)

PostEntitiesAlertsV1

Retrieve all Alerts given their IDs.

PEP8 method name

get_alerts_v1 (or get_alerts)

Endpoint

Method Route
POST /alerts/entities/alerts/v1

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
ids
Service Class Support

Uber Class Support
body string or list of strings ID(s) of the alerts to retrieve.

Specify one or more alert IDs (max 1000 per request). Find alert IDs with the GetQueriesAlertsV1 operation.

Usage

In order to use this method, either a body keyword or the ids keyword must be provided.

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_alerts_v1(ids=id_list)

print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.PostEntitiesAlertsV1(ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("PostEntitiesAlertsV1", ids=id_list)

print(response)

PostEntitiesAlertsV2

Retrieve all Alerts given their composite IDs.

PEP8 method name

get_alerts_v2

Endpoint

Method Route
POST /alerts/entities/alerts/v2

Content-Type

  • Consumes: application/json
  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
body
Service Class Support

Uber Class Support
body dictionary Full body payload in JSON format.
composite_ids
Service Class Support

Uber Class Support
body string or list of strings ID(s) of the alerts to retrieve.

Specify one or more alert IDs (max 1000 per request). Find alert IDs with the GetQueriesAlertsV1 operation.
include_hidden
Service Class Support

Uber Class Support
query string Allows previously hidden alerts to be retrieved.
parameters
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.

Usage

In order to use this method, either a body keyword or the ids keyword must be provided.

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_alerts_v2(composite_ids=id_list, include_hidden=boolean)

print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.PostEntitiesAlertsV2(composite_ids=id_list, include_hidden=boolean)

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "composite_ids": ["ID1", "ID2", "ID3"]
}

response = falcon.command("PostEntitiesAlertsV2", body=body_payload, include_hidden=boolean)

print(response)

GetQueriesAlertsV1

Search for alert IDs that match a given query.

PEP8 method name

query_alerts_v1 (or query_alerts)

Endpoint

Method Route
GET /alerts/queries/alerts/v1

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
filter
Service Class Support

Uber Class Support
query string Filter alerts using a query in Falcon Query Language (FQL) An asterisk wildcard * includes all results.
limit
Service Class Support

Uber Class Support
query integer The maximum number of alerts to return in this response (default: 10000; max: 10000). Use with the offset parameter to manage pagination of results.
offset
Service Class Support

Uber Class Support
query integer The first alert to return, where 0 is the latest alert. Use with the limit parameter to manage pagination of results.
parameters
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.
q
Service Class Support

Uber Class Support
query string Search all alert metadata for the provided string
sort
Service Class Support

Uber Class Support
query string Sort alerts using the provided FQL filter.

Usage

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.query_alerts_v1(offset=integer,
                                  limit=integer,
                                  sort="string",
                                  filter="string",
                                  q="string"
                                  )
print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.GetQueriesAlertsV1(offset=integer,
                                     limit=integer,
                                     sort="string",
                                     filter="string",
                                     q="string"
                                     )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("GetQueriesAlertsV1",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string",
                          q="string"
                          )
print(response)

GetQueriesAlertsV2

Search for alert IDs that match a given query.

PEP8 method name

query_alerts_v2

Endpoint

Method Route
GET /alerts/queries/alerts/v2

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Data type Description
filter
Service Class Support

Uber Class Support
query string Filter alerts using a query in Falcon Query Language (FQL) An asterisk wildcard * includes all results.
include_hidden
Service Class Support

Uber Class Support
query string Allows previously hidden alerts to be retrieved.
limit
Service Class Support

Uber Class Support
query integer The maximum number of alerts to return in this response (default: 100; max: 10000). Use with the offset parameter to manage pagination of results.
offset
Service Class Support

Uber Class Support
query integer The first alert to return, where 0 is the latest alert. Use with the limit parameter to manage pagination of results.
parameters
Service Class Support

Uber Class Support
query dictionary Full query string parameters payload in JSON format.
q
Service Class Support

Uber Class Support
query string Search all alert metadata for the provided string
sort
Service Class Support

Uber Class Support
query string Sort alerts using the provided FQL filter.

Usage

Service class example (PEP8 syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.query_alerts_v2(offset=integer,
                                  limit=integer,
                                  include_hidden=boolean,
                                  sort="string",
                                  filter="string",
                                  q="string"
                                  )
print(response)
Service class example (Operation ID syntax)
from falconpy import Alerts

# Do not hardcode API credentials!
falcon = Alerts(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.GetQueriesAlertsV2(offset=integer,
                                     limit=integer,
                                     include_hidden=boolean,
                                     sort="string",
                                     filter="string",
                                     q="string"
                                     )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("GetQueriesAlertsV2",
                          offset=integer,
                          include_hidden=boolean,
                          limit=integer,
                          sort="string",
                          filter="string",
                          q="string"
                          )
print(response)

CrowdStrike Falcon

Clone this wiki locally