Event¶
-
class
cloudpassage.
Event
(session, **kwargs)¶ Event class:
Parameters: session ( cloudpassage.HaloSession
) – This will define how you interact with the Halo API, including proxy settings and API keys used for authentication.-
list_all
(pages, **kwargs)¶ Return a list of all events.
Default filter returns ALL events. This is a very verbose and time-consuming operation.
Filtering is done with keyword arguments, some of which are listed below. An exhaustive list of filters can be found at https://api-doc.cloudpassage.com/help#events
Parameters: pages (int) – Max number of pages (of ten items each) to retrieve
Keyword Arguments: - group_id (list or str) – A list or comma-separated string containing the group IDs to retrieve events for.
- server_id (list or str) – A list or comma-separated string containing the server IDs to retrieve events for.
- server_platform (str) – (linux | windows)
- critical (bool) – Returns only critical or noncritical events.
- type (list or str) – A list or comma-separated string containing the event types to query for. A complete list of event types is available here: https://api-doc.cloudpassage.com/help#event-types
- since (str) – ISO 8601 formatted string representing the starting date and time for query
- until (str) – ISO 8601 formatted string representing the ending date and time for query
Returns: List of dictionary objects describing servers
Return type:
-