Skip to main content
Skip table of contents

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:

D3 SOAR

V12.7.241+

Category

Threat Intelligence

Deployment Options

Option I, Option II, Option III, Option IV

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:

Parameter

Description

Example

Server URL

The URL of the AbuseIPDB server.

https://api.abuseipdb.com

API Version

The API version of AbuseIPDB.

v2

API Key

The API key used for authentication.

4cfce8*************************************************07e697************************************9c53cc

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

Input Parameter

Required/Optional

Description

Example

IP List

Required

A valid IPv4 or IPv6 address list.

["37.59.**.***"]

Output

Raw Data

The primary response data from the API request. For check reputation commands, D3-defined risk levels and risk level names are also included.

SAMPLE DATA

CODE
{
    "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": []
}
Return Data

In check reputation commands, Return Data displays the risk score from the raw data as D3-defined risk levels and risk level names. This will be used to enrich artifacts with reputation information.

SAMPLE DATA

CODE
[{
    "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>"
    }
]
Key Fields

Common cyber security indicators such as risk levels, risk level names, unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

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

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ip

riskLevel

37.59.**.***

ZeroRisk

 D3-defined Risk Levels and Risk Level Names

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

Risk Levels

Risk Level Names

1

High

2

Medium

3

Low

4

Default

5

ZeroRisk

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.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Check IP Reputation failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the AbuseIPDB portal. Refer to the HTTP Status Code Registry for details.

Status Code: 422.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: The ip address must be a valid IPv4 or IPv6 address (e.g. 8.8.8.8 or 2001:4860:4860::8888).

Error Sample Data

Check IP Reputation failed.

Status Code: 422.

Message: The ip address must be a valid IPv4 or IPv6 address (e.g. 8.8.8.8 or 2001:4860:4860::8888).

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

Input Parameter

Required/Optional

Description

Example

Network List

Required

The check-block endpoint accepts a subnet (IPv4 or IPv6), written in CIDR notation.

["127.0.0.1/24"]

Max age in days

Optional

Determines the age of the reports that are considered in the query search. The default value is 30.

5

Output

Return Data

Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.

The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

The Failed state can be triggered by any of the following errors:

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "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": []
}
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

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

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CIDRBlockIPCount

1

 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.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Check CIDR Block failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the AbuseIPDB portal. Refer to the HTTP Status Code Registry for details.

Status Code: 422.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: Invalid CIDR format.

Error Sample Data

Check CIDR Block failed.

Status Code: 422.

Message: Invalid CIDR format.

Get Black List

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

Input

Input Parameter

Required/Optional

Description

Example

Limit

Optional

All users can set the limit between 1 and 10,000.

5

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
{
    "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"
        }
    ]
}
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.

The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

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

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

BlackListItemCount

5

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.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Get Black List failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the AbuseIPDB portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: Unauthorized.

Error Sample Data

Get Black List failed.

Status Code: 401.

Message: Unauthorized.

Get Categories

Returns a list of category names.

Input

N/A

Output

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Raw Data

The primary response data from the API request.

SAMPLE DATA

CODE
[
    {
        "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"
    }
]
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CategoryCount

23

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.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Get Categories failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the AbuseIPDB portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: Unauthorized.

Error Sample Data

Get Categories failed.

Status Code: 401.

Message: Unauthorized.

Report IP

Sends a POST request to report an IP address.

Input

Input Parameter

Required/Optional

Description

Example

IP List

Required

The list of valid IPv4 or IPv6 addresses used to retrieve a report.

["1.6.37.***","1.6.10*.**"]

Category name list

Required

The category name list used to retrieve a report. At least one category is required, but you may add additional categories using commas to separate the category names.

[

"Frad_Orders",

"Brute_Force"

]

Output

Return Data

Indicates one of the possible command execution states: Successful, Partially Successful, or Failed.

The Partially Successful state only occurs when a command’s input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

The Failed state can be triggered by any of the following errors:

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Raw Data

The primary response data from the API request.

SAMPLE DATA

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

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

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

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ipAddress

abuseConfidenceScore

1.6.37.***

100

1.6.10*.**

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.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Report IP failed.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the AbuseIPDB portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: Invalid categories found: 111.

Error Sample Data

Report IP failed.

Status Code: 401.

Message: Invalid categories found: 111.

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

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

  • A connection issue with the integration

  • The API returned an error message

  • No response from the API

You can view more details about an error in the Error tab.

SAMPLE DATA

CODE
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.

Parts in Error

Description

Example

Failure Indicator

Indicates the command failure that happened at a specific input and/or API call.

Test Connection failed. Failed to check the connector.

Status Code

The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the AbuseIPDB portal. Refer to the HTTP Status Code Registry for details.

Status Code: 401.

Message

The raw data or captured key error message from the integration API server about the API request failure.

Message: Unauthorized.

Error Sample Data

Test Connection failed. Failed to check the connector.

Status Code: 401.

Message: Unauthorized.

JavaScript errors detected

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

If this problem persists, please contact our support.