Related Methods: Siemplify.add_entities_to_custom_list, Siemplify.any_entity_in_custom_list, Siemplify.remove_entities_from_custom_list, Siemplify.get_existing_custom_list_categories, Siemplify.is_existing_category, Siemplify._get_custom_list_items

The custom list is just a list of objects, that can be saved into Siemplify’s DBs, as a shared resource, fetched and queried by each script execution instance.
The custom list can be edited in settings screen’s UI. This section deals with SDK functionalities for custom lists

Custom List item structure:
This object is defined in the SiemplifyDataModel.py

Param Name Param Type Possible Values
identifier string Any identifier whatsoever. Usually this identifier represents a possible entity in future alerts
category string Category from the Siemplify settings
environment string Environment name from the Siemplify settings

To create a CustomList object, do the following: 

from SiemplifyAction import SiemplifyAction 
from SiemplifyDataModel import CustomList 
custom_list = CustomList(identifier="1.2.3.4", category="WhiteListed HOSTs", environment="")

When referring to the CustomList object in the future, this is its structure. Below, we can see an example of a single object in the settings screen. Every line represents a single CustomList object.