Get Internal or External IP Addresses‎

POST /Command/FilterInternalIP

Extracts a list of internal or external IP addresses from the input IP addresses

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 Addresses	`array<string>`	Required	The input list of IP addresses to extract from
IP Type	`string`	Required	The type of IP addresses to get from the input list of IP addresses

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "IP Addresses": [
      "10.10.1.xxx",
      "192.168.12.xxx",
      "172.17.12.xxx",
      "173.254.152.xxx",
      "45.32.76.xxx",
      "121.64.92.xxx"
    ],
    "IP Type": "Internal"
  }
}

Response

200 OK

application/json

Response Fields

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

Sample Data

JSON

{
    "error": "",
    "returnData": [
      "10.10.1.xxx",
      "192.168.12.xxx",
      "172.17.12.xxx"
  ]
}

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."}