laceworksdk.api.v2.activities

Lacework Activities API wrapper.

 1# -*- coding: utf-8 -*-
 2"""
 3Lacework Activities API wrapper.
 4"""
 5
 6from laceworksdk.api.search_endpoint import SearchEndpoint
 7
 8
 9class ActivitiesAPI:
10    """A class used to represent the Activities API endpoint.
11
12    The Activities API endpoint is simply a parent for different types of
13    activities that can be queried.
14
15    Attributes
16    ----------
17    changed_files:
18        A ChangedFilesAPI instance.
19    connections:
20        A ConnectionsAPI instance.
21    dns:
22        A DnsAPI instance.
23    user_logins:
24        A UserLoginsAPI instance.
25    """
26
27    def __init__(self, session):
28        """Initializes the ActivitiesAPI object.
29
30        :param session: An instance of the HttpSession class
31
32        :return ActivitiesAPI object.
33        """
34
35        super().__init__()
36        self._base_path = "Activities"
37
38        self.changed_files = ChangedFilesAPI(session, self._base_path)
39        self.connections = ConnectionsAPI(session, self._base_path)
40        self.dns = DnsAPI(session, self._base_path)
41        self.user_logins = UserLoginsAPI(session, self._base_path)
42
43
44class ChangedFilesAPI(SearchEndpoint):
45    """A class used to represent the Changed Files API endpoint.
46
47    Methods
48    -------
49    search(json=None)
50        A method to search ChangedFiles objects.
51    """
52    RESOURCE = "ChangedFiles"
53
54
55class ConnectionsAPI(SearchEndpoint):
56    """A class used to represent the Connections API endpoint.
57
58    Methods
59    -------
60    search(json=None)
61        A method to search Connections objects.
62    """
63    RESOURCE = "Connections"
64
65
66class DnsAPI(SearchEndpoint):
67    """A class used to represent the DNS Lookup API endpoint.
68
69    Methods
70    -------
71    search(json=None)
72        A method to search DNS lookup objects.
73    """
74    RESOURCE = "DNSs"
75
76
77class UserLoginsAPI(SearchEndpoint):
78    """A class used to represent the UserLogins API endpoint.
79
80    Methods
81    -------
82    search(json=None)
83        A method to search UserLogins objects.
84    """
85    RESOURCE = "UserLogins"
class ActivitiesAPI:
10class ActivitiesAPI:
11    """A class used to represent the Activities API endpoint.
12
13    The Activities API endpoint is simply a parent for different types of
14    activities that can be queried.
15
16    Attributes
17    ----------
18    changed_files:
19        A ChangedFilesAPI instance.
20    connections:
21        A ConnectionsAPI instance.
22    dns:
23        A DnsAPI instance.
24    user_logins:
25        A UserLoginsAPI instance.
26    """
27
28    def __init__(self, session):
29        """Initializes the ActivitiesAPI object.
30
31        :param session: An instance of the HttpSession class
32
33        :return ActivitiesAPI object.
34        """
35
36        super().__init__()
37        self._base_path = "Activities"
38
39        self.changed_files = ChangedFilesAPI(session, self._base_path)
40        self.connections = ConnectionsAPI(session, self._base_path)
41        self.dns = DnsAPI(session, self._base_path)
42        self.user_logins = UserLoginsAPI(session, self._base_path)

A class used to represent the Activities API endpoint.

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

Attributes

changed_files: A ChangedFilesAPI instance. connections: A ConnectionsAPI instance. dns: A DnsAPI instance. user_logins: A UserLoginsAPI instance.

ActivitiesAPI(session)
28    def __init__(self, session):
29        """Initializes the ActivitiesAPI object.
30
31        :param session: An instance of the HttpSession class
32
33        :return ActivitiesAPI object.
34        """
35
36        super().__init__()
37        self._base_path = "Activities"
38
39        self.changed_files = ChangedFilesAPI(session, self._base_path)
40        self.connections = ConnectionsAPI(session, self._base_path)
41        self.dns = DnsAPI(session, self._base_path)
42        self.user_logins = UserLoginsAPI(session, self._base_path)

Initializes the ActivitiesAPI object.

Parameters
  • session: An instance of the HttpSession class

:return ActivitiesAPI object.

class ChangedFilesAPI(laceworksdk.api.search_endpoint.SearchEndpoint):
45class ChangedFilesAPI(SearchEndpoint):
46    """A class used to represent the Changed Files API endpoint.
47
48    Methods
49    -------
50    search(json=None)
51        A method to search ChangedFiles objects.
52    """
53    RESOURCE = "ChangedFiles"

A class used to represent the Changed Files API endpoint.

Methods

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

RESOURCE = 'ChangedFiles'
class ConnectionsAPI(laceworksdk.api.search_endpoint.SearchEndpoint):
56class ConnectionsAPI(SearchEndpoint):
57    """A class used to represent the Connections API endpoint.
58
59    Methods
60    -------
61    search(json=None)
62        A method to search Connections objects.
63    """
64    RESOURCE = "Connections"

A class used to represent the Connections API endpoint.

Methods

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

RESOURCE = 'Connections'
67class DnsAPI(SearchEndpoint):
68    """A class used to represent the DNS Lookup API endpoint.
69
70    Methods
71    -------
72    search(json=None)
73        A method to search DNS lookup objects.
74    """
75    RESOURCE = "DNSs"

A class used to represent the DNS Lookup API endpoint.

Methods

search(json=None) A method to search DNS lookup objects.

RESOURCE = 'DNSs'
class UserLoginsAPI(laceworksdk.api.search_endpoint.SearchEndpoint):
78class UserLoginsAPI(SearchEndpoint):
79    """A class used to represent the UserLogins API endpoint.
80
81    Methods
82    -------
83    search(json=None)
84        A method to search UserLogins objects.
85    """
86    RESOURCE = "UserLogins"

A class used to represent the UserLogins API endpoint.

Methods

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

RESOURCE = 'UserLogins'