laceworksdk.api.v2.configs

Lacework Configs API wrapper.

 1# -*- coding: utf-8 -*-
 2"""
 3Lacework Configs API wrapper.
 4"""
 5
 6from laceworksdk.api.search_endpoint import SearchEndpoint
 7
 8
 9class ConfigsAPI:
10    """A class used to represent the Configs API endpoint.
11
12    The Configs API endpoint is simply a parent for different types of
13    configs that can be queried.
14
15    Attributes
16    ----------
17    compliance_evaluations:
18        A ComplianceEvaluationsAPI instance.
19    """
20
21    def __init__(self, session):
22        """Initializes the ConfigsAPI object.
23
24        :param session: An instance of the HttpSession class
25
26        :return ConfigsAPI object.
27        """
28
29        super().__init__()
30        self._base_path = "Configs"
31
32        self.compliance_evaluations = ComplianceEvaluationsAPI(session, self._base_path)
33
34
35class ComplianceEvaluationsAPI(SearchEndpoint):
36    """A class used to represent the Compliance Evaluations API endpoint.
37
38    Methods
39    -------
40    search(json=None)
41        A method to search ComplianceEvaluations objects.
42    """
43    RESOURCE = "ComplianceEvaluations"
class ConfigsAPI:
10class ConfigsAPI:
11    """A class used to represent the Configs API endpoint.
12
13    The Configs API endpoint is simply a parent for different types of
14    configs that can be queried.
15
16    Attributes
17    ----------
18    compliance_evaluations:
19        A ComplianceEvaluationsAPI instance.
20    """
21
22    def __init__(self, session):
23        """Initializes the ConfigsAPI object.
24
25        :param session: An instance of the HttpSession class
26
27        :return ConfigsAPI object.
28        """
29
30        super().__init__()
31        self._base_path = "Configs"
32
33        self.compliance_evaluations = ComplianceEvaluationsAPI(session, self._base_path)

A class used to represent the Configs API endpoint.

The Configs API endpoint is simply a parent for different types of configs that can be queried.

Attributes

compliance_evaluations: A ComplianceEvaluationsAPI instance.

ConfigsAPI(session)
22    def __init__(self, session):
23        """Initializes the ConfigsAPI object.
24
25        :param session: An instance of the HttpSession class
26
27        :return ConfigsAPI object.
28        """
29
30        super().__init__()
31        self._base_path = "Configs"
32
33        self.compliance_evaluations = ComplianceEvaluationsAPI(session, self._base_path)

Initializes the ConfigsAPI object.

Parameters
  • session: An instance of the HttpSession class

:return ConfigsAPI object.

class ComplianceEvaluationsAPI(laceworksdk.api.search_endpoint.SearchEndpoint):
36class ComplianceEvaluationsAPI(SearchEndpoint):
37    """A class used to represent the Compliance Evaluations API endpoint.
38
39    Methods
40    -------
41    search(json=None)
42        A method to search ComplianceEvaluations objects.
43    """
44    RESOURCE = "ComplianceEvaluations"

A class used to represent the Compliance Evaluations API endpoint.

Methods

search(json=None) A method to search ComplianceEvaluations objects.

RESOURCE = 'ComplianceEvaluations'