Check if IP is within a Range

Last updated: Aug 06, 2024

Checks if an IP address is within the range of a lower IP and an upper IP

Implementation	System
Command Category	Cyber Utility
Tags	Condition Artifact IP

Inputs

Parameter Name	Required/Optional	Description	Sample Data
IP Address	Required	IP Address to check	192.168.0.242
Lower IP Address	Required	IP Address as start of a range	192.168.0.1
Upper IP Address	Required	IP Address as end of a range	192.168.0.255

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/IsIPInRange

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": {
    "IP Address": <IP Address to check>,
    "Lower IP Address": <IP Address as start of a range>,
    "Upper IP Address": <IP Address as end of a range>
  }
}

Body Parameters

Parameter Name	Type	Required	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
IP Address	`string`	Required	IP Address to check
Lower IP Address	`string`	Required	IP Address as start of a range
Upper IP Address	`string`	Required	IP Address as end of a range

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "IP Address": "192.168.0.242",
    "Lower IP Address": "192.168.0.1",
    "Upper IP Address": "192.168.0.255"
  }
}

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,
}