Lists
Overview
Set of tools to facilitate managing custom lists.
Actions
Search Custom List
Description
Search a specified string within the records of a custom list. (If no values are provided will return all custom lists records)
Parameters
| Parameter | Type | Default Value | Is Mandatory | Description |
| String to Search | String | N/A | No | Specify string to search within the records in a custom list. |
| Categories | String | N/A | No | Specify the custom list category to search within. |
Example
In this scenario, we’re searching if “.com” is part of any records in a custom list with category "Blocked Domains".
Action Configurations
| Parameter | Value |
| Entities | All entities |
| String to Search | .com |
| Categories | Blocked Domains |
Action Results
-
Script Result
Script Result Name Value options Example Match_Records True/False true -
JSON Result
[{ "entityIdentifier": "sample.com", "category": "Blocked Domains", "forDBMigration": false, "environments": ["*"], "id": 1, "creationTimeUnixTimeInMs": 1674846992575, "modificationTimeUnixTimeInMs": 1674846992575 }]
Is String In Custom List
Description
Checks if a string is in a custom list.
Parameters
| Parameter | Type | Default Value | Is Mandatory | Description |
| ListItem | String | N/A | Yes | Specify string to add to a custom list. |
| Category | String | Allowlist | Yes | Specify the custom list category/name. |
Example
In this scenario, it’s checking if an IP address of 0.0.0.0 exists in a list category called bad_ips_list.
Action Configurations
| Parameter | Value |
| Entities | All entities |
| IdentifierList | 0.0.0.0 |
| Categories | bad_ips_list |
Action Results
- Script Result
| Script Result Name | Value options | Example |
| NumOf FoundResults | True/False | true |
-
JSON Result
{ "Entity" : "0.0.0.0", "EntityResult" : "true" }
Add String to Custom List
Description
Adds a string to a custom list.
Parameters
| Parameter | Type | Default Value | Is Mandatory | Description |
| ListItem | String | N/A | Yes | Specify string to add to a custom list. |
| Category | String | Allowlist | Yes | Specify the custom list category/name. |
Example
In this scenario, an IP address of 0.0.0.1 is added to a custom list category called bad_ips_list.
Action Configurations
| Parameter | Value |
| Entities | All entities |
| Listitem | 0.0.0.1 |
| Categories | bad_ips_list |
Action Results
-
Script Result
Script Result Name Value options Example NumOf FoundResults True/False true -
JSON Result
{ "Entity" : "0.0.0.0", "EntityResult" : "true" }
Remove String from Custom List
Description
Removes a string from a custom list.
Parameters
| Parameter | Type | Default Value | Is Mandatory | Description |
| Category | String | Allowlist | Yes | Specify the custom list category/name. |
| ListItem | String | N/A | Yes | Specify string to remove from a custom list. |
Example
In this scenario, an IP address 0.0.0.1 is removed from a custom list category called bad_ips_list.
Action Configurations
| Parameter | Value |
| Entities | All entities |
| IdentifierList | 0.0.0.1 |
| Categories | bad_ips_list |
Action Results
-
Script Result
Script Result Name Value options Example NumOfFoundResults True/False true -
JSON Result
{ "Entity" : "0.0.0.0", "EntityResult" : "true" }