APIVoid 2.0.0
App Vendor: APIVoid
App Category: Data Enrichment & Threat Intelligence
Connector Version: 2.0.0
API Version: 1.0.0
Note
This app is currently released as a beta version.
About App
The APIVoid app enables security teams to analyze IPs, domains, and URLs for potential threats. It leverages threat intelligence to detect fraud, malware, and other security risks.
The APIVoid app is configured with Cyware Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Check Parked Domain | This action can be used to check if a domain is parked or for sale. |
Fetch Certificate Information | This action retrieves information about a certificate. |
Fetch Domain Age Info | This action can be used to get the domain's age information. |
Fetch Domain Reputation | This action can be used to get a domain's reputation. |
Fetch Domain Threat Log | This action can be used to fetch the domain threat log. |
Fetch IP Address Reputation | This action can be used to check the IP address reputation. |
Query DNS Lookup | This action can be used to get common DNS records for a domain. |
Query Email Domain Lookup | This action can be used to query an email domain lookup in APIVoid. |
Generic Action | This is a generic action used to make requests to any APIVoid endpoint. |
Configuration Parameters
The following configuration parameters are required for the APIVoid app to communicate with the APIVoid enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to access the APIVoid API. Example: https://endpoint.apivoid.com | Text | Optional | Default value: https://endpoint.apivoid.com |
API Key | Enter the API key for authentication. Example: fa0xxxxxxxxxx6xxxxxxxxxxxxxxxxxxxxxxxx50 | Password | Required | |
Verify | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. | Boolean | Optional | By default, verification is enabled. |
Timeout | Enter the timeout value in seconds. This is the number of seconds requests will wait to connect to APIVoid and read the response. | Integer | Optional | Allowed range: 15-120 Default value: 15 |
Action: Check Parked Domain
This action checks if a domain is parked or for sale.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain to check if it is parked or for sale. Example: example.com | Text | Required |
Example Request
[
{
"domain": "example.com"
}
]Action: Fetch Certificate Information
This action retrieves information about a certificate.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain to fetch certificate details. Example: example.com | Text | Required |
Example Request
[
{
"domain": "google.com"
}
]Action: Fetch Domain Age Info
This action retrieves the domain's age information.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain to fetch its age. Example: example.com | Text | Required |
Example Request
[
{
"domain": "example.com"
}
]Action: Fetch Domain Reputation
This action retrieves a domain's reputation.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain to fetch the reputation. Example: example.com | Text | Required |
Example Request
[
{
"domain": "example.com"
}
]Action: Fetch Domain Threat Log
This action retrieves the domain threat log.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain to retrieve the threat log. Example: example.com | Text | Required |
Example Request
[
{
"domain": "example.com"
}
]Action: Fetch IP Address Reputation
This action checks the reputation of an IP address.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
IP Address | Enter the IP address to fetch the reputation. Example: 1.1.1.1 | Text | Required |
Example Request
[
{
"ip_address": "8.8.8.8"
}
]Action: Query DNS Lookup
This action retrieves common DNS records for a domain.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain to retrieve DNS records. Example: example.com | Text | Required | |
Report Type | Enter the type of the report. Example: a | Text | Required | Allowed values: a, aaaa, ns, mx, txt, soa, dmarc, ptr, any, cname, srv, caa |
Action: Query Email Domain Lookup
This action queries an email domain lookup in APIVoid.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enter the email address to look up. Example: john.doe@orgname.com | Text | Required |
Example Request
[
{
"email": "john.doe@orgname.com"
}
]Action: Generic Action
This is a generic action used to make requests to any APIVoid endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed values: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request. Example: /iprep/v1/pay-as-you-go | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional | Allowed keys: payload_json, custom_output, download, filename, files, retry_wait, retry_count, response_type |