APIVoid

LAST UPDATED: SEPTEMBER 18, 2025

Overview

APIVoid provides JSON APIs useful for cyber threat analysis, threat detection and threat prevention, reducing and automating the manual work of security analysts.

D3 SOAR is providing REST operations to function with APIVoid.

APIVoid is available for use in:

Known Limitations

Check APIVoid uptime on the status page. For more information about rate limits, refer to APIVoid Documentation for detailed information.

Connection

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

Configuring APIVoid to Work with D3 SOAR

1. Log into the APIVoid web interface.

2. Visit the Dashboard to check the remaining credits.

3. Having zero credit will result in the failure of all commands, including the Test Connection command.

4. The Test Connection command and any unsuccessful API calls will not consume credits.

5. Click “Buy More Credits” if out of credits.

   

6. Click on My API Keys, and select Add API Key.

7. Save the API Key.

READER NOTE

Credits are valid for one year only. More API keys can be added or modified. Ensure that the API keys in VSOC are current.

WARNING

Too many requests with an incorrect API key will trigger an ERROR, locking the IP address. Please reach out to customer support or wait approximately one hour for the lock to be lifted.

Configuring D3 SOAR to Work with APIVoid

1. Log in to D3 SOAR.

2. Find the APIVoid integration.

   

   1. Navigate to Configuration on the top header menu.

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

   3. Type APIVoid 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 APIVoid.

   

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

   2. Site: The site on which to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all 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 is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.

   4. Agent Name (Optional): 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): The description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, users can choose the specific tenant sites with which to share the connection. Once this setting is enabled, users 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: The checkbox that enables the connection to be used when selected.

   9. System Reputation Check: Selecting one or more reputation checkboxes will run the corresponding check reputation commands under this integration connection to enrich the corresponding artifacts with reputation details.

      For example, an integration connection named "ConnectionA" is configured with the "Sandbox" site. All URL artifacts from the "Sandbox" site will undergo a reputation check using the Check URL Reputation command from that integration. The return data output from this command will then be used to update the risk level of 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://endpoint.apivoid.com.

       2. Copy the API Key from the APIVoid platform.

       3. Input the API Version. The default value is v1.

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

   12. Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.

4. Test the connection.

   

   1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.

   2. Click OK to close the alert window.

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

Commands

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

Integration API Note

For more information about the APIVoid API, refer to the APIVoid API reference.

Check IP Reputation

Checks the risk level of Public IPv4 addresses.

Input

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

Output

To view the sample output data for all commands, refer to this article.

D3-defined Risk Scores and Risk Levels

The table below lists the possible output Risk Scores and their corresponding Risk Levels:

Error Handling

An Error tab will appear in the Test Result window if the command fails to run.

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 locate the root cause of a command failure.

Check URL Reputation

Checks the risk level of URL(s).

Input

[
  "https://www.*****.***"
]

Output

To view the sample output data for all commands, refer to this article.

D3-defined Risk Scores and Risk Levels

The table below lists the possible output Risk Scores and their corresponding Risk Levels:

Error Handling

An Error tab will appear in the Test Result window if the command fails to run.

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 locate the root cause of a command failure.

Check Domain Reputation

Checks the risk level of the domain(s).

Input

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

Output

To view the sample output data for all commands, refer to this article.

D3-defined Risk Scores and Risk Levels

The table below lists the possible output Risk Scores and their corresponding Risk Levels:

Error Handling

An Error tab will appear in the Test Result window if the command fails to run.

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 locate the root cause of a command failure.

Check Email Reputation

Checks the risk level of email(s).

Input

[
  "*****@*****.***"
]

Output

To view the sample output data for all commands, refer to this article.

D3-defined Risk Scores and Risk Levels

The table below lists the possible output Risk Scores and their corresponding Risk Levels:

Error Handling

An Error tab will appear in the Test Result window if the command fails to run.

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 locate the root cause of a command failure.

Get Screenshot

Retrieves the screenshot from a URL.

Input

Output

To view the sample output data for all commands, refer to this article.

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 locate the root cause of a command failure.

Test Connection

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

Input

N/A

Output

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 locate the root cause of a command failure.