AbuseIPDB

LAST UPDATED: 04/22/2024

Overview

AbuselPDB API allows you to report abusive IPs and instantly check if an IP has been reported.

D3 SOAR is providing REST operations to function with AbuseIPDB.

AbuseIPDB is available for use in:

Known Limitations

The API rate limit is based on your account subscription. You can navigate to User Accounts > Plans on the AbuseIPDB UI to check or change your account plan.

Please refer to AbuseIPDB API for detailed information.

Connection

To connect to AbuseIPDB from D3 SOAR, please follow this part to collect the required information below:

Configuring AbuseIPDB to Work with D3 SOAR

1. Go to https://www.abuseipdb.com/account.

2. Login to AbuseIPDB with your E-Mail Address and Password.

   

3. On the User Account page, click the API tab, and you can click Create Key.

   

4. Copy and save the API Key.

   

Configuring D3 SOAR to Work with AbuseIPDB

1. Log in to D3 SOAR.

2. Find the AbuseIPDB integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type AbuseIPDB in the search box to find the integration, then click it to select it.

   4. Click + Connection, on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to AbuseIPDB.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add your desired description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: Check the tick box to ensure the connection is available for use.

   9. System Reputation Check: Checking one or more reputation check tick boxes will run the corresponding check reputation command(s) under this integration connection to enrich the corresponding artifacts with reputation details. 
      
      For example, we are configuring an integration connection named “ConnectionA” with the site “Sandbox”. All IP artifacts from the “Sandbox” site will go through a reputation check using the Check IP Reputation command from that integration. The return data output from running the command will then be used to update the risk level of the artifacts which may affect the risk level of incoming events.

      

   10. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
       1. Input the Server URL. The default value is https://api.abuseipdb.com.
       2. Input the API Key that was copied from the AbuseIPDB platform. Please refer to step 4 of Configuring AbuseIPDB to Work with D3 SOAR for more details.
       3. Input the API Version. The default value is v2.

   11. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

   12. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
       To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.

4. Test the connection.

   

   1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

AbuseIPDB includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the AbuseIPDB API, please refer to the AbuseIPDB API reference.

Check IP Reputation

Checks the reputation of a particular IP address.

Input

Output

{
    "results": [
        {
            "ipAddress": "37.59.**.***",
            "isPublic": true,
            "ipVersion": 4,
            "isWhitelisted": false,
            "abuseConfidenceScore": 0,
            "countryCode": "FR",
            "usageType": "Data Center/Web Hosting/Transit",
            "isp": "OVH SAS",
            "domain": "o**.com",
            "hostnames": [
                "sw****.ga****.net"
            ],
            "isTor": false,
            "totalReports": 0,
            "numDistinctUsers": 0,
            "lastReportedAt": "2022-07-05T13:39:15+00:00",
            "riskLevel": 5
        }
    ],
    "D3Errors": []
}

[{
    "ip": "37.59.**.***",
    "riskLevel": 5,
    "riskScore": 0,
    "riskName": "ZeroRisk",
    "RawData": {
        "ipAddress": "37.59.**.***",
        "isPublic": true,
        "ipVersion": 4,
        "isWhitelisted": false,
        "abuseConfidenceScore": 0,
        "countryCode": "FR",
        "usageType": "Data Center/Web Hosting/Transit",
        "isp": "OVH SAS",
        "domain": "o**.com",
        "hostnames": [
            "sw****.ga****.net"
        ],
        "isTor": false,
        "totalReports": 0,
        "numDistinctUsers": 0,
        "lastReportedAt": "2022-07-05T13:39:15+00:00",
        "riskLevel": 5
    },
    "BeautifiedHtml": "<table class="cc-table horizontal-table"><tr><th>Type</th><th>Indicator</th><th>Reputation</th><th>Category Group</th><th>D3 Risk Level</th></tr><tr><td>IPv4</td><td>37.59.**.***</td><td>0</td><td>Data Center/Web Hosting/Transit</td><td>5</td></tr></table>"
    }
]

{
    "abuseConfidenceScores": [
        "0"
    ],
    "ipAddresses": [
        "192.168.*.***"
    ]
}

 D3-defined Risk Levels and Risk Names

The table below lists the possible output risk levels and their corresponding risk names:

Error Handling

If your command fails to execute, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Check CIDR Block

Inspects details regarding the network that is being queried. The details include the netmask of the subnet, the number of hosts the subnet can possibly contain, and the assigned description of the address space.

Input

Output

Successful

{
    "results": [
        {
            "networkAddress": "127.0.0.0",
            "netmask": "255.255.255.0",
            "minAddress": "127.0.0.1",
            "maxAddress": "127.0.0.254",
            "numPossibleHosts": 254,
            "addressSpaceDesc": "Loopback",
            "reportedAddress": [
                {
                    "ipAddress": "127.0.0.1",
                    "numReports": 84,
                    "mostRecentReport": "2023-06-12T08:27:07+00:00",
                    "abuseConfidenceScore": 0,
                    "countryCode": null
                }
            ]
        }
    ],
    "D3Errors": []
}

{
    "abuseConfidenceScores": [
        "0", "0"
    ]
}

 Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Get Black List

The blacklist is a compilation of the diligent reports submitted by AbuseIPDB users, comprising the most frequently reported IP addresses.

Input

Output

Successful

{
    "meta": {
        "generatedAt": "2023-06-12T10:29:05+00:00"
    },
    "data": [
        {
            "ipAddress": "20.228.***.***",
            "countryCode": "US",
            "abuseConfidenceScore": 100,
            "lastReportedAt": "2023-06-12T10:17:02+00:00"
        },
        {
            "ipAddress": "185.150.***.**",
            "countryCode": "TR",
            "abuseConfidenceScore": 100,
            "lastReportedAt": "2023-06-12T10:17:01+00:00"
        }
    ]
}

{
    "ipAddresses": [
        "20.228.***.***", "185.150.***.**"],
    "abuseConfidenceScores": [
        "100", "100"]
}

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Get Categories

Returns a list of category names.

Input

N/A

Output

Successful

[
    {
        "id": "1",
        "name": "DNS_Compromise"
    },
    {
        "id": "2",
        "name": "DNS_Poisoning"
    },
    {
        "id": "3",
        "name": "Frad_Orders"
    },
    {
        "id": "4",
        "name": "DDoS_Attack"
    },
    {
        "id": "5",
        "name": "FTP_Brute-Force"
    },
    {
        "id": "6",
        "name": "Ping_of_Death"
    },
    {
        "id": "7",
        "name": "Phishing"
    },
    {
        "id": "8",
        "name": "Fraud_VoIP"
    },
    {
        "id": "9",
        "name": "Open_Proxy"
    },
    {
        "id": "10",
        "name": "Web_Spam"
    },
    {
        "id": "11",
        "name": "Email_Spam"
    },
    {
        "id": "12",
        "name": "Blog_Spam"
    },
    {
        "id": "13",
        "name": "VPN IP"
    },
    {
        "id": "14",
        "name": "Port_Scan"
    },
    {
        "id": "15",
        "name": "Hacking"
    },
    {
        "id": "16",
        "name": "SQL_Injection"
    },
    {
        "id": "17",
        "name": "Spoofing"
    },
    {
        "id": "18",
        "name": "Brute_Force"
    },
    {
        "id": "19",
        "name": "Bad_Web_Bot"
    },
    {
        "id": "20",
        "name": "Exploited_Host"
    },
    {
        "id": "21",
        "name": "Web_App_Attack"
    },
    {
        "id": "22",
        "name": "SSH"
    },
    {
        "id": "23",
        "name": "IoT_Targeted"
    }
]

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Report IP

Sends a POST request to report an IP address.

Input

Output

Successful

[
    {
        "data": {
            "ipAddress": "1.6.37.***",
            "abuseConfidenceScore": 100
        }
    },
    {
        "data": {
            "ipAddress": "1.6.10*.**",
            "abuseConfidenceScore": 100
        }
    }
]

{
    "ipAddresses": [
        "1.6.37.***", "1.6.10*.**"
    ],
    "abuseConfidenceScores": [
        "100", "100"
    ]
}

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.