:py:mod:`laceworksdk.api.v2.alert_profiles`
===========================================

.. py:module:: laceworksdk.api.v2.alert_profiles

.. autoapi-nested-parse::

   Lacework AlertProfiles API wrapper.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.alert_profiles.AlertProfilesAPI




.. py:class:: AlertProfilesAPI(session)


   Bases: :py:obj:`laceworksdk.api.crud_endpoint.CrudEndpoint`

   A class used to represent the `Alert Profiles API endpoint <https://docs.lacework.net/api/v2/docs/#tag/AlertProfiles>`_

   An alert profile is a set of metadata that defines how your LQL queries get consumed into events and alerts.

   .. py:property:: session

      Get the :class:`HttpSession` instance the object is using.

   .. py:method:: create(alert_profile_id, alerts, extends, **request_params)

      A method to create a new AlertProfiles object.

      :param alert_profile_id: A unique ID to name the new alert profile
      :type alert_profile_id: str
      :param extends: The base alert profile object.
      :type extends: str
      :param alerts: A list of dictionaries containing alert details to create. Alert fields are:

                     - name (str): The name of the alert.
                     - eventName (str): The name to show in Event Triage.
                     - description (str): The description to show in Event Triage.
                     - subject (str): The subject to show in the Event Dossier.
      :type alerts: list of dict
      :param request_params: Use to pass any additional parameters the API
      :type request_params: dict, optional

      :returns: A JSON object containing the created Alert Profile
      :rtype: dict


   .. py:method:: get(id=None)

      A method to get AlertProfiles objects.

      :param id: A string representing the alert profile ID.
      :type id: str

      :returns: The returned alert profile(s)
      :rtype: dict


   .. py:method:: get_by_id(id)

      A method to get an AlertProfiles object by ID.

      :param id: A string representing the alert profile ID.
      :type id: str

      :returns: The returned alert profile(s)
      :rtype: dict


   .. py:method:: search(**request_params)

      Search functionality is not yet implemented for Alert Profiles.


   .. py:method:: update(id, alerts=None, **request_params)

      A method to update an AlertProfiles object.

      :param id: A string representing the object ID.
      :type id: str
      :param alerts: A list of dictionaries containing alert details to update. Alert fields are:

                     - name (str): The name of the alert.
                     - eventName (str): The name to show in Event Triage.
                     - description (str): The description to show in Event Triage.
                     - subject (str): The subject to show in the Event Dossier.
      :type alerts: list of dicts
      :param request_params: Use to pass any additional parameters the API
      :type request_params: dict, optional

      :returns: The updated Alert Profile
      :rtype: dict


   .. py:method:: delete(id)

      A method to delete an AlertProfiles object.

      :param id: A string representing the alert profile ID.
      :type id: str

      :returns: a Requests response object containing the response code
      :rtype: requests.models.Response