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
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
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
IP Address |
| Required | IP Address to check |
Lower IP Address |
| Required | IP Address as start of a range |
Upper IP Address |
| Required | IP Address as end of a range |
Sample Request
SAMPLE DATA
{
"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 |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": true,
}