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

ParameterTypeDefault ValueIs MandatoryDescription
String to SearchStringN/ANoSpecify string to search within the records in a custom list.
CategoriesStringN/ANoSpecify 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.

Action Results

  • Script Result
    Script Result NameValue optionsExample
    Match_RecordsTrue/Falsetrue
  • 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

ParameterTypeDefault ValueIs MandatoryDescription
ListItemStringN/AYesSpecify string to add to a custom list.
CategoryStringAllowlistYesSpecify 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. If so, it returns the number of results found.

Action Results

  • Script Result
Script Result NameValue optionsExample
NumOf FoundResultsTrue/Falsetrue
  • JSON Result
    {
    "Entity" : "0.0.0.0",
    "EntityResult" : "true"
    }

Add String to Custom List

Description

Adds a string to a custom list.

Parameters

ParameterTypeDefault ValueIs MandatoryDescription
ListItemStringN/AYesSpecify string to add to a custom list.
CategoryStringAllowlistYesSpecify the custom list category/name.

Example

In this scenario, an IP address of 0.0.0.0 is added to a custom list category called bad_ips_list.

Action Results

  • Script Result
    Script Result NameValue optionsExample
    NumOf FoundResultsTrue/Falsetrue
  • JSON Result
    {
    "Entity" : "0.0.0.0",
    "EntityResult" : "true"
    }

Remove String from Custom List

Description

Removes a string from a custom list.

Parameters

ParameterTypeDefault ValueIs MandatoryDescription
CategoryStringAllowlistYesSpecify the custom list category/name.
ListItemStringN/AYesSpecify string to remove from a custom list.

Example

In this scenario, an IP address 0.0.0.0 is removed from a custom list category called bad_ips_list.

Action Results

  • Script Result
    Script Result NameValue optionsExample
    NumOfFoundResultsTrue/Falsetrue
  • JSON Result
    {
    "Entity" : "0.0.0.0",
    "EntityResult" : "true"
    }