Stay organized with collections
Save and categorize content based on your preferences.
Custom lists
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 the platform Settings screen. This section deals with SDK functionalities for
custom lists
Custom List item structure: This object is defined in
SiemplifyDataModel
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="203.0.113.1", category="AllowListed HOSTs", environment="")
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eCustom lists are shared lists of objects stored in Siemplify's databases, accessible and queryable by any script execution instance.\u003c/p\u003e\n"],["\u003cp\u003eCustom lists can be managed via the platform Settings screen, and the SDK offers specific functionalities for interacting with them.\u003c/p\u003e\n"],["\u003cp\u003eEach item in a custom list includes an identifier, a category sourced from the Siemplify settings, and an environment name also sourced from Siemplify settings.\u003c/p\u003e\n"],["\u003cp\u003eYou can create a \u003cem\u003eCustomList\u003c/em\u003e object using the \u003ccode\u003eCustomList\u003c/code\u003e class from the \u003ccode\u003eSiemplifyDataModel\u003c/code\u003e module, specifying an identifier, category, and environment.\u003c/p\u003e\n"],["\u003cp\u003eThere are related methods available in the Siemplify module, such as \u003ccode\u003eadd_entities_to_custom_list\u003c/code\u003e, \u003ccode\u003eany_entity_in_custom_list\u003c/code\u003e, \u003ccode\u003eremove_entities_from_custom_list\u003c/code\u003e, \u003ccode\u003eget_existing_custom_list_categories\u003c/code\u003e, and \u003ccode\u003eis_existing_category\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Custom lists\n============\n\n| **Note:** Related Methods: [Siemplify.add_entities_to_custom_list](/chronicle/docs/soar/reference/siemplify-module#entities-cl-siemplify), [Siemplify.any_entity_in_custom_list](/chronicle/docs/soar/reference/siemplify-module#any-entity-cl-siemplify), [Siemplify.remove_entities_from_custom_list](/chronicle/docs/soar/reference/siemplify-module#remove-entities-cl-siemplify), [Siemplify.get_existing_custom_list_categories](/chronicle/docs/soar/reference/siemplify-module#get-cl-categories-siemplify), [Siemplify.is_existing_category](/chronicle/docs/soar/reference/siemplify-module#is-category-siemplify)\n\n\nThe custom list is just a list of objects, that can be saved into\nSiemplify's DBs, as a shared resource, fetched and queried by each\nscript execution instance. \nThe custom list can be edited in the platform Settings screen. This section deals with SDK functionalities for\ncustom lists\n\n#### Custom List item structure:\nThis object is defined in\n[SiemplifyDataModel](/chronicle/docs/soar/reference/siemplify-data-model-module)\n\n\nTo create a *CustomList* object, do the\nfollowing: \n\n\n from SiemplifyAction import SiemplifyAction\n from SiemplifyDataModel import CustomList\n custom_list = CustomList(identifier=\"203.0.113.1\", category=\"AllowListed HOSTs\", environment=\"\")\n \n\u003cbr /\u003e\n\n\u003cbr /\u003e"]]
