laceworksdk.api.v2.reports

Lacework Reports API wrapper.

Module Contents

Classes

ReportsAPI

A class used to represent the Reports API endpoint
class laceworksdk.api.v2.reports.ReportsAPI(session)[source]

Bases: laceworksdk.api.base_endpoint.BaseEndpoint

A class used to represent the Reports API endpoint

Lacework combines details about non-compliant resources that are in violation into reports. You must configure at least one cloud integration with AWS, Azure, or GCP to receive these reports.

property session

Get the HttpSession instance the object is using.

get(primary_query_id=None, secondary_query_id=None, format=None, report_type=None, **request_params)[source]

A method to get Reports objects.

Parameters:

  • primary_query_id (str) – The primary ID that is used to fetch the report. (AWS Account ID or Azure Tenant ID)

  • secondary_query_id (str) – The secondary ID that is used to fetch the report. (GCP Project ID or Azure Subscription ID)

  • format (str, optional) – The format of the report. Valid values: “csv”, “html”, “json”, “pdf”

  • report_type (str) – The type of the report. See available reports for a list of report types. Valid values are in the “API Format” column.

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

Returns:

The details of the report

Return type:

dict