Check IP Subnet‎ | docs.d3security

POST /Command/checkIPSubnet

Check if IPs in subnets

Request

Authentication: API keys or JSON web tokens (JWT)

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.
IP Address List	`array<string>`	Optional	The IP list for subnet checking
Subnet List	`array<string>`	Optional	The subnet list for subnet checking

Body Sample Data

application/json

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "IP Address List": [
      "192.168.0.x",
      "192.168.1.x"
    ],
    "Subnet List": [
      "192.168.0.0/xx",
      "192.168.0.0/xx"
    ]
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
result	`string`	The result data from the API request.
error	`string`	The error message if the command execution failed.
returnData	`string`	The return data from the API request.
contextData	`array<JSON Object>`	The context data from the API request.

Sample Data

{
    "result": "<table class='cc-table horizontal-table'><tr><th>count</th><th>subnet</th><th>ipAddressList</th></tr><tr><td>1</td><td>192.168.0.0/24</td><td>[&#x27;192.168.0.1&#x27;]</td></tr><tr><td>2</td><td>192.168.0.0/16</td><td>[&#x27;192.168.0.1&#x27;, &#x27;192.168.1.1&#x27;]</td></tr></table>",
    "error": "",
    "returnData": "Successful",
    "rawData": "",
    "contextData": [
        {
            "count": 1,
            "subnet": "192.168.0.0/24",
            "ipAddressList": [
                "192.168.0.1"
            ]
        },
        {
            "count": 2,
            "subnet": "192.168.0.0/16",
            "ipAddressList": [
                "192.168.0.1",
                "192.168.1.1"
            ]
        }
    ],
    "outputData": ""
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}