laceworksdk.api.v2.alert_rules

Lacework AlertRules API wrapper.

Module Contents

Classes

AlertRulesAPI

A class used to represent the Alert Rules API endpoint
class laceworksdk.api.v2.alert_rules.AlertRulesAPI(session)[source]

Bases: laceworksdk.api.crud_endpoint.CrudEndpoint

A class used to represent the Alert Rules API endpoint

Lacework combines alert channels and alert rules to provide a flexible method for routing alerts. For alert channels, you define information about where to send alerts, such as to Jira, Slack, or email. For alert rules, you define information about which alert types to send, such as critical and high severity compliance alerts.

property session

Get the HttpSession instance the object is using.

create(type, filters, intg_guid_list, **request_params)[source]

A method to create new Alert Rules.

Parameters:

  • type (str) – The type of the alert rule. Valid values are: “Event”

  • filters (dict) – The alert rule definition. See the API docs for valid values.

  • intg_guid_list (list of str) – A list of GUIDs representing the alert channels to use.

  • request_params (dict, optional) – Use to pass any additional parameters the API

Returns:

The new rule.

Return type:

dict

get(guid=None)[source]

A method to get AlertRules objects.

Parameters:

guid (str) – The alert rule GUID to retrieve.

Returns:

The alert rule(s)

Return type:

dict

get_by_guid(guid)[source]

A method to get an AlertRules object by GUID.

Parameters:

guid (str) – The alert rule GUID.

Returns:

The alert rule

Return type:

dict

update(guid, filters=None, intg_guid_list=None, **request_params)[source]

A method to update an AlertRules object.

Parameters:

  • guid (str) – The Alert Rule GUID you wish to update.

  • filters (dict, optional) –

    The alert rule definition. See the API docs for valid values.

  • intg_guid_list (list of str, optional) – A list of GUIDs representing the alert channels to use.

  • request_params (dict, optional) – Use to pass any additional parameters the API

Returns:

The updated alert rule

Return type:

dict

delete(guid)[source]

A method to delete an AlertRules object.

Parameters:

guid (str) – The alert rule GUID.

Returns:

a Requests response object containing the response code

Return type:

requests.models.Response

search(json=None)

A method to search objects.

See the API documentation for this API endpoint for valid fields to search against.

NOTE: While the “value” and “values” fields are marked as “optional” you must use one of them, depending on the operation you are using.

Parameters:

json (dict) –

The desired search parameters:

  • timeFilter (dict, optional): A dict containing the time frame for the search:

    • startTime (str): The start time for the search

    • endTime (str): The end time for the search

  • filters (list of dict, optional): Filters based on field contents:

    • field (str): The name of the data field to which the condition applies

    • expression (str): The comparison operator for the filter condition. Valid values are:

    ”eq”, “ne”, “in”, “not_in”, “like”, “ilike”, “not_like”, “not_ilike”, “not_rlike”, “rlike”, “gt”, “ge”, “lt”, “le”, “between”

    • value (str, optional): The value that the condition checks for in the specified field. Use this attribute when using an operator that requires a single value.

    • values (list of str, optional): The values that the condition checks for in the specified field. Use this attribute when using an operator that requires multiple values.

  • returns (list of str, optional): The fields to return

Returns:

returns a dict containing the search results

Return type:

dict