Extract IP Addresses from Array of JSON Objects

Last updated: Aug 07, 2024

Scans a JSON Object and extracts all IP addresses into a list

Implementation	System
Command Category	Cyber Utility
Tags	Artifact Condition IP

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Input	Required	JSON Object containing IP addresses	`[ { "IP": "192.168.1.242" }, { "IP": "127.0.0.1" }, { "IP": "55.99.44.12" } ]`

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

{
    "Status": "Successful",
    "Data": {
        "InternalIPs": [
            "192.168.1.242",
            "127.0.0.1"
        ],
        "ExternalIPs": [
            "55.99.44.12"
        ]
    }
}

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

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": {
    "Input": <JSON Object containing IP addresses>
  }
}

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.
Input	`array<JSON Object>`	Required	JSON Object containing IP addresses

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Input": [
      {
        "IP": "192.168.1.242"
      },
      {
        "IP": "127.0.0.1"
      },
      {
        "IP": "55.99.44.12"
      }
    ]
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
keyFields	`string`	The key fields from the API request.
returnData	`JSON Object`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": {
      "Status": "Successful",
      "Data": {
          "InternalIPs": [
              "192.168.1.242",
              "127.0.0.1"
          ],
          "ExternalIPs": [
              "55.99.44.12"
          ]
      }
    }
}