Get IP Addresses Reputation‎

POST /Command/GetIpReputation

Inputs a list of IP addresses and returns their risk levels

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	IP Addresses array

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "IP Addresses": [
        "13.64.156.26",
        "13.64.156.27",
        "13.64.156.28",
        "13.64.156.22",
        "13.64.156.29"
    ]
  }
}

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.
outputData	`JSON Object`	The output data from the API request.

Sample Data

JSON

{
    "result": "<table class='cc-table'><th></th><th>IP Address</th><th>Risk Level</th><tr><td>1</td><td>13.64.156.26</td><td>N/A</td><tr><td>2</td><td>13.64.156.27</td><td>N/A</td><tr><td>3</td><td>13.64.156.28</td><td>N/A</td><tr><td>4</td><td>13.64.156.22</td><td>N/A</td><tr><td>5</td><td>13.64.156.29</td><td>N/A</td></table>",
    "error": "",
    "returnData": "Succeed",
    "rawData": "",
    "contextData": [
        {
            "ipAddress": "13.64.156.26",
            "risklevel": "Low"
        },
        {
            "ipAddress": "13.64.156.27",
            "risklevel": "Low"
        },
        {
            "ipAddress": "13.64.156.28",
            "risklevel": "Medium"
        },
        {
            "ipAddress": "13.64.156.22",
            "risklevel": "Medium"
        },
        {
            "ipAddress": "13.64.156.29",
            "risklevel": "Zero"
        }
    ],
    "outputData": {
        "NoneRiskLevel": [
            "13.64.156.26",
            "13.64.156.27",
            "13.64.156.28",
            "13.64.156.22",
            "13.64.156.29"
        ]
    }
}

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