Check Value Exists in Global List

Last updated: Aug 07, 2024

Returns true if the specified value is present in the global list, or returns false when the value is absent.

Implementation	System
Command Category	System Utility
Tags	Global list

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Global List Name	Optional	The name of the global list.	demoGlobalList
Value	Optional	The value of a key within the specified global list.	192.168.1.132

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

Sample Data

JSON

true

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

https:/{base_url}/{api_namespace}/api/Command/InList

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Global List Name": "<Global List Name here>",
    "Value": "<Value here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Global List Name	`string`	Required	The name of the global list.
Value	`string`	Required	The value of a key within the specified global list.

Sample Request

Sample Data

JSON

{
  "Username": "demoUsername",
  "Site": "demoSite",
  "CommandParams": {
    "Global List Name": "demoGlobalList",
    "Value": "192.168.1.132"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`boolean`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "true"
}