Get Email Addresses' Reputation‎

POST /Command/GetEmailAddressReputation

Returns a list of email addresses and 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.
List of Email Addresses	`array<string>`	Required	A text array containing multiple Email addresses

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "List of Email Addresses": [
      "jack@d3security.com",
      "tom@d3security.com",
      "amy@d3security.com",
      "jason@d3security.com",
      "jeff@d3security.com"
    ]
  }
}

Response

200 OK

application/json

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

Sample Data

JSON

{
    "result": "<table class='cc-table'><tr><th></th><th>Email</th><th>Risk Level</th></tr><tr><td>1</td><td>jack@d3security.com</td><td>N/A</td></tr><tr><td>2</td><td>tom@d3security.com</td><td>N/A</td></tr><tr><td>3</td><td>amy@d3security.com</td><td>N/A</td></tr><tr><td>4</td><td>jason@d3security.com</td><td>N/A</td></tr><tr><td>5</td><td>jeff@d3security.com</td><td>N/A</td></tr></table>",
    "error": "",
    "returnData": "Succeed",
    "rawData": "",
    "contextData": [
        {
            "email": "jack@d3security.com",
            "risklevel": "N/A"
        },
        {
            "email": "tom@d3security.com",
            "risklevel": "N/A"
        },
        {
            "email": "amy@d3security.com",
            "risklevel": "N/A"
        },
        {
            "email": "jason@d3security.com",
            "risklevel": "N/A"
        },
        {
            "email": "jeff@d3security.com",
            "risklevel": "N/A"
        }
    ],
    "outputData": {
        "Output": [
            {
                "email": "jack@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "tom@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "amy@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "jason@d3security.com",
                "risklevel": "N/A"
            },
            {
                "email": "jeff@d3security.com",
                "risklevel": "N/A"
            }
        ]
    }
}

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