laceworksdk.api.search_endpoint
The base search class for the Lacework Python SDK
Module Contents
Classes
A class used to implement Search functionality for Lacework API Endpoints. |
- class laceworksdk.api.search_endpoint.SearchEndpoint(session, object_type, endpoint_root='/api/v2')[source]
Bases:
laceworksdk.api.base_endpoint.BaseEndpoint
A class used to implement Search functionality for Lacework API Endpoints.
- property session
Get the
HttpSession
instance the object is using.
- search(json=None, resource=None)[source]
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
resource (str) – The Lacework API resource to search (Example: “AlertChannels”)
- Yields:
dict – returns a generator which yields a page of objects at a time as returned by the Lacework API.