Skip to main content
Skip table of contents

Check IP Reputation

LAST UPDATED: AUG 07, 2024

Get the reputation of external IPs from the system reputation integrations

Implementation

System

Command Category

Cyber Utility

Tags

REPUTATION ARTIFACT IP

Inputs

Parameter Name

Required/Optional

Description

Sample Data

externalIPs

Required

The external IPs

CODE
["8.8.8.8"]

Return Reputation Raw Data

Optional

Whether to return raw data of artifact's reputation

Yes

Return Reputation's HTML

Optional

Whether to return beautified HTML based on artifact's reputation

Yes

Output

Key Values

Important key-value pairs extracted from Raw Data.

SAMPLE DATA

CODE
{
  "IP":["8.8.8.8"],
  "RiskLevel":["High"]
}
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
Succeed
Raw Data

The response data from the utility command.

SAMPLE DATA

JSON
[
    {
        "IP": "8.8.8.8",
        "RiskLevel": "Low",
        "RiskLevelID": 3,
        "Reputation": [
            {
                "Resource": "webrootbcti",
                "RiskLevelID": "3",
                "RiskLevel": "Low"
            }
        ],
        "RawData": {
            "ip": "8.8.8.8",
            "queries": {
                "getinfo": {
                    "ipint": 134744072,
                    "ip_status": 0,
                    "reputation": 80,
                    "riskLevel": 3
                }
            }
        },
        "BeautifiedHtml": "<table class='cc-table horizontal-table'><tr><th>Type</th><th>Indicator</th><th>Reputation Score</th><th>Category Group</th><th>D3 Risk Level</th></tr><tr><td>IPv4</td><td>8.8.8.8</td><td>80</td><td>None</td><td>3</td></tr></table>"
    }
]
Context Data

The response data from the utility command.

SAMPLE DATA

JSON
[
    {
        "IP": "8.8.8.8",
        "RiskLevel": "Low",
        "RiskLevelID": 3,
        "RawData": {
            "ip": "8.8.8.8",
            "queries": {
                "getinfo": {
                    "ipint": 134744072,
                    "ip_status": 0,
                    "reputation": 80,
                    "riskLevel": 3
                }
            }
        },
        "BeautifiedHtml": "<table class='cc-table horizontal-table'><tr><th>Type</th><th>Indicator</th><th>Reputation Score</th><th>Category Group</th><th>D3 Risk Level</th></tr><tr><td>IPv4</td><td>8.8.8.8</td><td>80</td><td>None</td><td>3</td></tr></table>"
    }
]

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

CODE
https:/{base_url}/{api_namespace}/api/Command/CheckIPReputation

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": {
    "externalIPs": <The external Ips>,
    "Return Reputation Raw Data": <Whether to return raw data of artifact's reputation>,
    "Return Reputation's HTML": "<Whether to return beautified HTML based on artifact's reputation>
  }
}

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.

externalIPs

array<string>

Required

The external Ips

Return Reputation Raw Data

boolean

Optional

Whether to return raw data of artifact's reputation

Return Reputation's HTML

boolean

Optional

Whether to return beautified HTML based on artifact's reputation

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "externalIPs": [
      "8.8.8.8"
    ],
    "Return Reputation Raw Data": "Yes",
    "Return Reputation's HTML": "Yes"
  }
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

keyFields

JSON Object

The key field from the API request.

returnData

string

The return data from the API request.

rawData

array<JSON Object>

The raw data from the API request.

contextData

array<JSON Object>

The context data from the API request.

Sample Response

JSON
{
    "error": "",
    "keyFields": {
        "IP":["8.8.8.8"],
        "RiskLevel":["High"]
    },
    "returnData": "Succeed",
    "rawData": [
      {
        "IP": "8.8.8.8",
        "RiskLevel": "Low",
        "RiskLevelID": 3,
        "RawData": {
            "ip": "8.8.8.8",
            "queries": {
                "getinfo": {
                    "ipint": 134744072,
                    "ip_status": 0,
                    "reputation": 80,
                    "riskLevel": 3
                }
            }
        },
        "BeautifiedHtml": "<table class='cc-table horizontal-table'><tr><th>Type</th><th>Indicator</th><th>Reputation Score</th><th>Category Group</th><th>D3 Risk Level</th></tr><tr><td>IPv4</td><td>8.8.8.8</td><td>80</td><td>None</td><td>3</td></tr></table>"
      }
    ],
    "contextData": [
      {
        "IP": "8.8.8.8",
        "RiskLevel": "Low",
        "RiskLevelID": 3,
        "RawData": {
            "ip": "8.8.8.8",
            "queries": {
                "getinfo": {
                    "ipint": 134744072,
                    "ip_status": 0,
                    "reputation": 80,
                    "riskLevel": 3
                }
            }
        },
        "BeautifiedHtml": "<table class='cc-table horizontal-table'><tr><th>Type</th><th>Indicator</th><th>Reputation Score</th><th>Category Group</th><th>D3 Risk Level</th></tr><tr><td>IPv4</td><td>8.8.8.8</td><td>80</td><td>None</td><td>3</td></tr></table>"
      }
    ]
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.