Get Domains' Reputation | docs.d3security

Last updated: Aug 07, 2024

Gets risk level of domains listed in an Array

Implementation	System
Command Category	Cyber Utility
Tags	Artifact REPUTATION CONDITION Domain

Inputs

Parameter Name	Required/Optional	Description	Sample Data
List of Domains	Required	A JSON Array containing multiple Domains	`[ "http://example1.com ", "http://example2.com", "http://example3.com ", "http://example4.com ", "http://example5.com " ]`

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

Succeed

Context Data

The response data from the utility command.

Sample Data

JSON

[
    {
        "url": "example1.com",
        "riskLevel": "Low"
    },
    {
        "url": "example2.com",
        "riskLevel": "Medium"
    },
    {
        "url": "example3.com",
        "riskLevel": "High"
    },
    {
        "url": "example4.com",
        "riskLevel": "Zero"
    },
    {
        "url": "example5.com",
        "riskLevel": "None"
    }
]

Key Fields

Important key and value pairs extracted from Raw Data.

Sample Data

JSON

{
    "Output": [
        {
            "url": "example1.com",
            "riskLevel": "Low"
        },
        {
            "url": "example2.com",
            "riskLevel": "Medium"
        },
        {
            "url": "example3.com",
            "riskLevel": "High"
        },
        {
            "url": "example4.com",
            "riskLevel": "Zero"
        },
        {
            "url": "example5.com",
            "riskLevel": "None"
        }
    ]
}

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

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": {
    "List of Domains": [
      <Domain 1 here>,
      <Domain 2 here>,
      <Domain 3 here>,
      <Domain 4 here>,
      <Domain 5 here>
    ]
  }
}

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.
List of Domains	`array<string>`	Required	A JSON Array containing multiple Domains

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "List of Domains": [
      "example1.com",
      "example2.com",
      "example3.com",
      "example4.com",
      "example5.com"
    ]
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "result": "<table class='cc-table'><th>URL</th><th>Risk Level</th><tr><td>example1.com</td><td>Low</td></tr><tr><td>example2.com</td><td>Medium</td></tr><tr><td>example3.com</td><td>High</td></tr><tr><td>example4.com</td><td>Zero</td></tr><tr><td>example5.com</td><td>None</td></tr></table>",
    "error": "",
    "returnData": "Succeed",
    "contextData": [
        {
            "url": "example1.com",
            "riskLevel": "Low"
        },
        {
            "url": "example2.com",
            "riskLevel": "Medium"
        },
        {
            "url": "example3.com",
            "riskLevel": "High"
        },
        {
            "url": "example4.com",
            "riskLevel": "Zero"
        },
        {
            "url": "example5.com",
            "riskLevel": "None"
        }
    ]，
    {
    "keyFields": {
        "Output": [
            {
                "url": "example1.com",
                "riskLevel": "Low"
            },
            {
                "url": "example2.com",
                "riskLevel": "Medium"
            },
            {
                "url": "example3.com",
                "riskLevel": "High"
            },
            {
                "url": "example4.com",
                "riskLevel": "Zero"
            },
            {
                "url": "example5.com",
                "riskLevel": "None"
            }
        ]
    }
}